@prismicio/editor-fields 0.4.58-alpha.repeatable-link-base.0 → 0.4.58-alpha.repeatable-link-base.1

package/dist/core/service/documentSearch.d.ts

@@ -1,15 +1,21 @@
 import { type AuthStrategy, type EditorConfig } from "../../EditorConfig";
 import { type DocumentVersion } from "./document";
+import type { Repository } from "./repository";
 interface SearchDocumentsArgs {
     coreApiBaseUrl: URL;
     documentSearchBaseUrl: URL;
     authStrategy: AuthStrategy;
     repository: string;
-    searchTerm: string;
-    customTypes: string[];
-    tags: string[];
-    status: DocumentVersion["status"][];
-    locale: string;
+    searchTerm?: string;
+    customTypes?: string[];
+    tags?: string[];
+    authors?: string[];
+    status?: DocumentVersion["status"][];
+    locale?: string;
+    /**
+     * TODO: Remove after all repos have been migrated to storageVerison 7 or above (PBD-1908)
+     */
+    storageVersion?: Repository["storageVersion"];
     searchDocumentsWithInterestingVersions: boolean;
     track: ((args: {
         numberOfResults: number;
@@ -20,6 +26,42 @@ interface SearchDocumentsArgs {
     signal: AbortSignal;
 }
 export declare function searchDocuments(args: SearchDocumentsArgs): Promise<{
+    results: {
+        id: string;
+        title: string;
+        language: {
+            isMaster?: boolean | undefined;
+            id: string;
+            label: string;
+        };
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            author: {
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                email?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            preview_image?: string | undefined;
+            uid?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+    }[];
+} | {
     results: {
         id: string;
         title: string;
@@ -48,11 +90,16 @@ export declare function searchDocuments(args: SearchDocumentsArgs): Promise<{
     }[];
 }>;
 interface searchDocumentsQueryOptionsArgs {
-    searchTerm: string;
-    customTypes: string[];
-    tags: string[];
-    status: DocumentVersion["status"][];
-    locale: string;
+    searchTerm?: string;
+    customTypes?: string[];
+    tags?: string[];
+    authors?: string[];
+    status?: DocumentVersion["status"][];
+    locale?: string;
+    /**
+     * TODO: Remove after all repos have been migrated to storageVerison 7 or above (PBD-1908)
+     */
+    storageVersion?: Repository["storageVersion"];
     config: SearchDocumentsConfig;
     track?: (args: {
         numberOfResults: number;
@@ -62,6 +109,42 @@ interface searchDocumentsQueryOptionsArgs {
     }) => void;
 }
 export declare function searchDocumentsQueryOptions(args: searchDocumentsQueryOptionsArgs): import("@tanstack/react-query/build/legacy/types").UseQueryOptions<{
+    results: {
+        id: string;
+        title: string;
+        language: {
+            isMaster?: boolean | undefined;
+            id: string;
+            label: string;
+        };
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            author: {
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                email?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            preview_image?: string | undefined;
+            uid?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+    }[];
+} | {
     results: {
         id: string;
         title: string;
@@ -89,6 +172,42 @@ export declare function searchDocumentsQueryOptions(args: searchDocumentsQueryOp
         })[];
     }[];
 }, Error, {
+    results: {
+        id: string;
+        title: string;
+        language: {
+            isMaster?: boolean | undefined;
+            id: string;
+            label: string;
+        };
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            author: {
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                email?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            preview_image?: string | undefined;
+            uid?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+    }[];
+} | {
     results: {
         id: string;
         title: string;
@@ -120,11 +239,12 @@ export declare function searchDocumentsQueryOptions(args: searchDocumentsQueryOp
     readonly documentSearchBaseUrl: URL;
     readonly authStrategy: AuthStrategy;
     readonly repository: string;
-    readonly searchTerm: string;
-    readonly customTypes: string[];
-    readonly tags: string[];
-    readonly status: ("published" | "release" | "archived" | "unclassified")[];
-    readonly locale: string;
+    readonly searchTerm: string | undefined;
+    readonly customTypes: string[] | undefined;
+    readonly tags: string[] | undefined;
+    readonly authors: string[] | undefined;
+    readonly status: ("published" | "release" | "archived" | "unclassified")[] | undefined;
+    readonly locale: string | undefined;
     readonly searchDocumentsWithInterestingVersions: boolean;
     readonly track: ((args: {
         numberOfResults: number;
@@ -132,8 +252,48 @@ export declare function searchDocumentsQueryOptions(args: searchDocumentsQueryOp
         numberOfWords: number;
         timeToGetResultsInMs: number;
     }) => void) | undefined;
+    readonly storageVersion: {
+        major: number;
+        minor: number;
+    } | undefined;
 }]> & {
     initialData?: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").L<{
+        results: {
+            id: string;
+            title: string;
+            language: {
+                isMaster?: boolean | undefined;
+                id: string;
+                label: string;
+            };
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                author: {
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    email?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                preview_image?: string | undefined;
+                uid?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+        }[];
+    } | {
         results: {
             id: string;
             title: string;
@@ -167,11 +327,12 @@ export declare function searchDocumentsQueryOptions(args: searchDocumentsQueryOp
         readonly documentSearchBaseUrl: URL;
         readonly authStrategy: AuthStrategy;
         readonly repository: string;
-        readonly searchTerm: string;
-        readonly customTypes: string[];
-        readonly tags: string[];
-        readonly status: ("published" | "release" | "archived" | "unclassified")[];
-        readonly locale: string;
+        readonly searchTerm: string | undefined;
+        readonly customTypes: string[] | undefined;
+        readonly tags: string[] | undefined;
+        readonly authors: string[] | undefined;
+        readonly status: ("published" | "release" | "archived" | "unclassified")[] | undefined;
+        readonly locale: string | undefined;
         readonly searchDocumentsWithInterestingVersions: boolean;
         readonly track: ((args: {
             numberOfResults: number;
@@ -179,7 +340,47 @@ export declare function searchDocumentsQueryOptions(args: searchDocumentsQueryOp
             numberOfWords: number;
             timeToGetResultsInMs: number;
         }) => void) | undefined;
+        readonly storageVersion: {
+            major: number;
+            minor: number;
+        } | undefined;
     }], {
+        results: {
+            id: string;
+            title: string;
+            language: {
+                isMaster?: boolean | undefined;
+                id: string;
+                label: string;
+            };
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                author: {
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    email?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                preview_image?: string | undefined;
+                uid?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+        }[];
+    } | {
         results: {
             id: string;
             title: string;

package/dist/core/service/index.d.ts

@@ -3,5 +3,5 @@ export * from "./document";
 export * from "./documentSearch";
 export * from "./onboarding";
 export * from "./repository";
-export * from "./teamSpace";
+export * from "./role";
 export * from "./user";

package/dist/core/service/repository.d.ts

@@ -210,4 +210,133 @@ declare const repositoryTagsResponse: z.ZodObject<{
 }>;
 type RepositoryTags = z.TypeOf<typeof repositoryTagsResponse>;
 export declare function getRepositoryTags(baseUrl: URL, authStrategy: AuthStrategy): Promise<RepositoryTags>;
+declare const repositoryQuotasV2: z.ZodObject<{
+    maxNbEnvironments: z.ZodNumber;
+    integrationFieldsEnabled: z.ZodBoolean;
+    personalEnvironmentsEnabled: z.ZodBoolean;
+    sliceMachineEnabled: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    maxNbEnvironments: number;
+    integrationFieldsEnabled: boolean;
+    personalEnvironmentsEnabled: boolean;
+    sliceMachineEnabled: boolean;
+}, {
+    maxNbEnvironments: number;
+    integrationFieldsEnabled: boolean;
+    personalEnvironmentsEnabled: boolean;
+    sliceMachineEnabled: boolean;
+}>;
+export type RepositoryQuotasV2 = z.TypeOf<typeof repositoryQuotasV2>;
+export declare const repositorySchemaV2: z.ZodObject<{
+    _id: z.ZodString;
+    name: z.ZodString;
+    onboarding: z.ZodObject<{
+        completedSteps: z.ZodArray<z.ZodString, "many">;
+        isDismissed: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        completedSteps: string[];
+        isDismissed: boolean;
+    }, {
+        completedSteps: string[];
+        isDismissed: boolean;
+    }>;
+    framework: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>, "next" | "nuxt" | "sveltekit" | "other", unknown>>>;
+    quotas: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        maxNbEnvironments: z.ZodNumber;
+        integrationFieldsEnabled: z.ZodBoolean;
+        personalEnvironmentsEnabled: z.ZodBoolean;
+        sliceMachineEnabled: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        maxNbEnvironments: number;
+        integrationFieldsEnabled: boolean;
+        personalEnvironmentsEnabled: boolean;
+        sliceMachineEnabled: boolean;
+    }, {
+        maxNbEnvironments: number;
+        integrationFieldsEnabled: boolean;
+        personalEnvironmentsEnabled: boolean;
+        sliceMachineEnabled: boolean;
+    }>>>;
+    storageVersion: z.ZodObject<{
+        major: z.ZodNumber;
+        minor: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        major: number;
+        minor: number;
+    }, {
+        major: number;
+        minor: number;
+    }>;
+    authors: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        firstname: z.ZodOptional<z.ZodString>;
+        lastname: z.ZodOptional<z.ZodString>;
+        email: z.ZodString;
+        uploadedAvatar: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        email: string;
+        uploadedAvatar?: string | undefined;
+        firstname?: string | undefined;
+        lastname?: string | undefined;
+    }, {
+        id: string;
+        email: string;
+        uploadedAvatar?: string | undefined;
+        firstname?: string | undefined;
+        lastname?: string | undefined;
+    }>, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    authors: {
+        id: string;
+        email: string;
+        uploadedAvatar?: string | undefined;
+        firstname?: string | undefined;
+        lastname?: string | undefined;
+    }[];
+    quotas: {
+        maxNbEnvironments: number;
+        integrationFieldsEnabled: boolean;
+        personalEnvironmentsEnabled: boolean;
+        sliceMachineEnabled: boolean;
+    };
+    framework: "next" | "nuxt" | "sveltekit" | "other";
+    storageVersion: {
+        major: number;
+        minor: number;
+    };
+    _id: string;
+    onboarding: {
+        completedSteps: string[];
+        isDismissed: boolean;
+    };
+}, {
+    name: string;
+    storageVersion: {
+        major: number;
+        minor: number;
+    };
+    _id: string;
+    onboarding: {
+        completedSteps: string[];
+        isDismissed: boolean;
+    };
+    authors?: {
+        id: string;
+        email: string;
+        uploadedAvatar?: string | undefined;
+        firstname?: string | undefined;
+        lastname?: string | undefined;
+    }[] | undefined;
+    quotas?: {
+        maxNbEnvironments: number;
+        integrationFieldsEnabled: boolean;
+        personalEnvironmentsEnabled: boolean;
+        sliceMachineEnabled: boolean;
+    } | undefined;
+    framework?: unknown;
+}>;
+export type RepositoryV2 = z.infer<typeof repositorySchemaV2>;
+export declare function getRepositoryV2(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<RepositoryV2>;
 export {};

package/dist/core/service/role.d.ts

@@ -0,0 +1,141 @@
+import { z } from "zod";
+import type { AuthStrategy } from "../../EditorConfig";
+export declare const LocaleId: z.ZodString;
+export declare const BasicRole: z.ZodEnum<["Manager", "Writer", "Readonly"]>;
+export declare const RolesPerLocale: z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>;
+export type RolesPerLocale = z.infer<typeof RolesPerLocale>;
+export declare const RolesPerLocaleByUser: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>>;
+export type RolesPerLocaleByUser = z.infer<typeof RolesPerLocaleByUser>;
+export declare const TeamSpace: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    customTypes: z.ZodArray<z.ZodString, "many">;
+    rolesPerLocale: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>>;
+    rolesPerLocaleByUser: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    customTypes: string[];
+    rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+    rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+}, {
+    id: string;
+    name: string;
+    customTypes: string[];
+    rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+    rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+}>;
+export type TeamSpace = z.infer<typeof TeamSpace>;
+declare const TeamSpaceUpsert: z.ZodObject<{
+    name: z.ZodString;
+    customTypes: z.ZodArray<z.ZodString, "many">;
+    rolesPerLocale: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>>;
+    rolesPerLocaleByUser: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    customTypes: string[];
+    rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+    rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+}, {
+    name: string;
+    customTypes: string[];
+    rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+    rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+}>;
+export type TeamSpaceUpsert = z.infer<typeof TeamSpaceUpsert>;
+declare const TeamSpacesResponse: z.ZodObject<{
+    results: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        customTypes: z.ZodArray<z.ZodString, "many">;
+        rolesPerLocale: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>>;
+        rolesPerLocaleByUser: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodEnum<["Manager", "Writer", "Readonly"]>>>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        customTypes: string[];
+        rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+        rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+    }, {
+        id: string;
+        name: string;
+        customTypes: string[];
+        rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+        rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    results: {
+        id: string;
+        name: string;
+        customTypes: string[];
+        rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+        rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+    }[];
+}, {
+    results: {
+        id: string;
+        name: string;
+        customTypes: string[];
+        rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+        rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+    }[];
+}>;
+export type TeamSpacesResponse = z.infer<typeof TeamSpacesResponse>;
+interface GetTeamSpacesArgs {
+    baseUrl: URL;
+    repository: string;
+    authStrategy: AuthStrategy;
+    fetchEnabled: boolean;
+}
+export declare function getTeamSpaces(args: GetTeamSpacesArgs): Promise<TeamSpacesResponse>;
+export declare function getTeamSpacesOptions(args: GetTeamSpacesArgs): import("@tanstack/react-query/build/legacy/types").UseQueryOptions<{
+    results: {
+        id: string;
+        name: string;
+        customTypes: string[];
+        rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+        rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+    }[];
+}, Error, {
+    id: string;
+    name: string;
+    customTypes: string[];
+    rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+    rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+}[], string[]> & {
+    initialData?: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").L<{
+        results: {
+            id: string;
+            name: string;
+            customTypes: string[];
+            rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+            rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+        }[];
+    }> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").E<string[], {
+        results: {
+            id: string;
+            name: string;
+            customTypes: string[];
+            rolesPerLocale?: Record<string, "Manager" | "Writer" | "Readonly"> | undefined;
+            rolesPerLocaleByUser?: Record<string, Record<string, "Manager" | "Writer" | "Readonly">> | undefined;
+        }[];
+    }>;
+};
+interface CreateTeamSpaceArgs {
+    baseUrl: URL;
+    repository: string;
+    authStrategy: AuthStrategy;
+    payload: TeamSpaceUpsert;
+}
+export declare function createTeamSpace(args: CreateTeamSpaceArgs): Promise<TeamSpace>;
+interface UpdateTeamSpaceArgs {
+    baseUrl: URL;
+    repository: string;
+    authStrategy: AuthStrategy;
+    payload: TeamSpaceUpsert;
+    teamSpaceId: string;
+}
+export declare function updateTeamSpace(args: UpdateTeamSpaceArgs): Promise<TeamSpace>;
+export {};