@aashari/mcp-server-atlassian-confluence
Version:
Node.js/TypeScript MCP server for Atlassian Confluence. Provides tools enabling AI systems (LLMs) to list/get spaces & pages (content formatted as Markdown) and search via CQL. Connects AI seamlessly to Confluence knowledge bases using the standard MCP in
1,467 lines (1,466 loc) • 41.7 kB
TypeScript
/**
* Types for Atlassian Confluence Spaces API
*/
import { z } from 'zod';
import { DescriptionFormat } from './vendor.atlassian.types.js';
/**
* Legacy type definitions - these will be replaced by inferred types from Zod schemas
*/
/**
* Space type enum
*/
export type SpaceType = 'global' | 'personal' | 'collaboration' | 'knowledge_base';
/**
* Space status enum
*/
export type SpaceStatus = 'current' | 'archived';
/**
* Space sort order enum
*/
export type SpaceSortOrder = 'id' | '-id' | 'key' | '-key' | 'name' | '-name';
/**
* Space property object - alias for ContentProperty with no additional fields
*/
/**
* Parameters for listing spaces
*/
export interface ListSpacesParams {
ids?: string[];
keys?: string[];
type?: SpaceType;
status?: SpaceStatus;
labels?: string[];
favoritedBy?: string;
notFavoritedBy?: string;
sort?: SpaceSortOrder;
descriptionFormat?: DescriptionFormat;
includeIcon?: boolean;
cursor?: string;
limit?: number;
}
/**
* Parameters for getting a space by ID
*/
export interface GetSpaceByIdParams {
descriptionFormat?: DescriptionFormat;
includeIcon?: boolean;
includeOperations?: boolean;
includeProperties?: boolean;
includePermissions?: boolean;
includeRoleAssignments?: boolean;
includeLabels?: boolean;
}
/**
* Zod schemas for Atlassian Confluence Spaces API responses
*/
/**
* Space type enum schema
*/
export declare const SpaceTypeSchema: z.ZodEnum<["global", "personal", "collaboration", "knowledge_base"]>;
/**
* Space status enum schema
*/
export declare const SpaceStatusSchema: z.ZodEnum<["current", "archived"]>;
/**
* Space sort order enum schema
*/
/**
* Content representation schema
*/
export declare const ContentRepresentationSchema: z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>;
/**
* Space description schema
*/
export declare const SpaceDescriptionSchema: z.ZodNullable<z.ZodObject<{
plain: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}>>;
/**
* Space icon schema
*/
export declare const SpaceIconSchema: z.ZodNullable<z.ZodObject<{
path: z.ZodOptional<z.ZodString>;
apiDownloadLink: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}>>;
/**
* Space links schema
*/
export declare const SpaceLinksSchema: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}>;
/**
* Permission subject schema
*/
export declare const PermissionSubjectSchema: z.ZodObject<{
type: z.ZodEnum<["user", "group"]>;
identifier: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "user" | "group";
identifier: string;
}, {
type: "user" | "group";
identifier: string;
}>;
/**
* Optional field metadata schema
*/
export declare const OptionalFieldMetaSchema: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
/**
* Optional field links schema
*/
export declare const OptionalFieldLinksSchema: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
/**
* Operation schema (for permissions)
*/
export declare const OperationSchema: z.ZodObject<{
key: z.ZodOptional<z.ZodString>;
target: z.ZodOptional<z.ZodString>;
targetType: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}>;
/**
* Space permission assignment schema
*/
export declare const SpacePermissionAssignmentSchema: z.ZodObject<{
id: z.ZodString;
subject: z.ZodObject<{
type: z.ZodEnum<["user", "group"]>;
identifier: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "user" | "group";
identifier: string;
}, {
type: "user" | "group";
identifier: string;
}>;
operation: z.ZodObject<{
key: z.ZodOptional<z.ZodString>;
target: z.ZodOptional<z.ZodString>;
targetType: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}, {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}>;
/**
* Space role assignment schema
*/
export declare const SpaceRoleAssignmentSchema: z.ZodObject<{
id: z.ZodString;
role: z.ZodString;
subject: z.ZodObject<{
type: z.ZodEnum<["user", "group"]>;
identifier: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "user" | "group";
identifier: string;
}, {
type: "user" | "group";
identifier: string;
}>;
}, "strip", z.ZodTypeAny, {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}, {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}>;
/**
* Label schema
*/
export declare const LabelSchema: z.ZodObject<{
id: z.ZodString;
name: z.ZodString;
prefix: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
id: string;
name: string;
prefix?: string | undefined;
}, {
id: string;
name: string;
prefix?: string | undefined;
}>;
/**
* Space property schema
*/
export declare const SpacePropertySchema: z.ZodObject<{
id: z.ZodString;
key: z.ZodString;
value: z.ZodAny;
version: z.ZodOptional<z.ZodObject<{
number: z.ZodNumber;
message: z.ZodOptional<z.ZodString>;
minorEdit: z.ZodOptional<z.ZodBoolean>;
authorId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
}, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}, {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}>;
/**
* Base Space schema (common fields between basic and detailed spaces)
*/
export declare const SpaceSchema: z.ZodObject<{
id: z.ZodString;
key: z.ZodString;
name: z.ZodString;
type: z.ZodEnum<["global", "personal", "collaboration", "knowledge_base"]>;
status: z.ZodEnum<["current", "archived"]>;
authorId: z.ZodString;
createdAt: z.ZodString;
homepageId: z.ZodNullable<z.ZodString>;
description: z.ZodOptional<z.ZodNullable<z.ZodObject<{
plain: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}>>>;
icon: z.ZodOptional<z.ZodNullable<z.ZodObject<{
path: z.ZodOptional<z.ZodString>;
apiDownloadLink: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}>>>;
_links: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}>;
currentActiveAlias: z.ZodOptional<z.ZodString>;
spaceOwnerId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
}, {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
}>;
/**
* Optional collection schema - used for labels, properties, operations, etc.
*/
export declare const OptionalCollectionSchema: <T extends z.ZodTypeAny>(itemSchema: T) => z.ZodObject<{
results: z.ZodArray<T, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: T["_output"][];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: T["_input"][];
meta: {
count?: number | undefined;
};
}>;
/**
* Detailed Space schema with additional properties
*/
export declare const SpaceDetailedSchema: z.ZodObject<{
id: z.ZodString;
key: z.ZodString;
name: z.ZodString;
type: z.ZodEnum<["global", "personal", "collaboration", "knowledge_base"]>;
status: z.ZodEnum<["current", "archived"]>;
authorId: z.ZodString;
createdAt: z.ZodString;
homepageId: z.ZodNullable<z.ZodString>;
description: z.ZodOptional<z.ZodNullable<z.ZodObject<{
plain: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}>>>;
icon: z.ZodOptional<z.ZodNullable<z.ZodObject<{
path: z.ZodOptional<z.ZodString>;
apiDownloadLink: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}>>>;
_links: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}>;
currentActiveAlias: z.ZodOptional<z.ZodString>;
spaceOwnerId: z.ZodOptional<z.ZodString>;
} & {
labels: z.ZodOptional<z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
id: z.ZodString;
name: z.ZodString;
prefix: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
id: string;
name: string;
prefix?: string | undefined;
}, {
id: string;
name: string;
prefix?: string | undefined;
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}>>;
properties: z.ZodOptional<z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
id: z.ZodString;
key: z.ZodString;
value: z.ZodAny;
version: z.ZodOptional<z.ZodObject<{
number: z.ZodNumber;
message: z.ZodOptional<z.ZodString>;
minorEdit: z.ZodOptional<z.ZodBoolean>;
authorId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
}, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}, {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}[];
meta: {
count?: number | undefined;
};
}>>;
operations: z.ZodOptional<z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
key: z.ZodOptional<z.ZodString>;
target: z.ZodOptional<z.ZodString>;
targetType: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}>>;
permissions: z.ZodOptional<z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
id: z.ZodString;
subject: z.ZodObject<{
type: z.ZodEnum<["user", "group"]>;
identifier: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "user" | "group";
identifier: string;
}, {
type: "user" | "group";
identifier: string;
}>;
operation: z.ZodObject<{
key: z.ZodOptional<z.ZodString>;
target: z.ZodOptional<z.ZodString>;
targetType: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}, {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}[];
meta: {
count?: number | undefined;
};
}>>;
roleAssignments: z.ZodOptional<z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
id: z.ZodString;
role: z.ZodString;
subject: z.ZodObject<{
type: z.ZodEnum<["user", "group"]>;
identifier: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "user" | "group";
identifier: string;
}, {
type: "user" | "group";
identifier: string;
}>;
}, "strip", z.ZodTypeAny, {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}, {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}[];
meta: {
count?: number | undefined;
};
}>>;
}, "strip", z.ZodTypeAny, {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
labels?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
properties?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
operations?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
permissions?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}[];
meta: {
count?: number | undefined;
};
} | undefined;
roleAssignments?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
}, {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
labels?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
properties?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
id: string;
value?: any;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
} | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
operations?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
permissions?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
operation: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
};
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
}[];
meta: {
count?: number | undefined;
};
} | undefined;
roleAssignments?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
subject: {
type: "user" | "group";
identifier: string;
};
role: string;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
}>;
/**
* Paginated response schema for spaces
*/
export declare const SpacesResponseSchema: z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
id: z.ZodString;
key: z.ZodString;
name: z.ZodString;
type: z.ZodEnum<["global", "personal", "collaboration", "knowledge_base"]>;
status: z.ZodEnum<["current", "archived"]>;
authorId: z.ZodString;
createdAt: z.ZodString;
homepageId: z.ZodNullable<z.ZodString>;
description: z.ZodOptional<z.ZodNullable<z.ZodObject<{
plain: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}, {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
}>>>;
icon: z.ZodOptional<z.ZodNullable<z.ZodObject<{
path: z.ZodOptional<z.ZodString>;
apiDownloadLink: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}, {
path?: string | undefined;
apiDownloadLink?: string | undefined;
}>>>;
_links: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}>;
currentActiveAlias: z.ZodOptional<z.ZodString>;
spaceOwnerId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
}, {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
}>, "many">;
_links: z.ZodOptional<z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
results: {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
}[];
_links?: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
} | undefined;
}, {
results: {
key: string;
status: "current" | "archived";
id: string;
name: string;
type: "global" | "personal" | "collaboration" | "knowledge_base";
authorId: string;
createdAt: string;
homepageId: string | null;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
};
description?: {
plain?: {
value: string;
representation: string;
} | undefined;
view?: {
value: string;
representation: string;
} | undefined;
} | null | undefined;
icon?: {
path?: string | undefined;
apiDownloadLink?: string | undefined;
} | null | undefined;
currentActiveAlias?: string | undefined;
spaceOwnerId?: string | undefined;
}[];
_links?: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
} | undefined;
}>;
/**
* Inferred types from Zod schemas
*/
export type SpaceDetailedSchemaType = z.infer<typeof SpaceDetailedSchema>;