@prismicio/types-internal 2.2.1-alpha.0 → 2.2.1-remove-import.alpha-1

package/lib/import/validators/Document.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportDocument = void 0;
-const tslib_1 = require("tslib");
-const fp_ts_1 = require("fp-ts");
-const Either_1 = require("fp-ts/Either");
-const function_1 = require("fp-ts/lib/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const customtypes_1 = require("../../customtypes");
-const Objects_1 = require("../../utils/Objects");
-const function_2 = require("../../validators/function");
-const ImportField_1 = require("./fields/ImportField");
-const rawImportDocument = (0, function_2.withCustomError)(t.UnknownRecord, () => "document is not an object");
-function validateField(document, customType) {
-    return (key, content, model) => {
-        // the field is not defined in the custom type -> extra field or typo
-        if (!model) {
-            const error = {
-                value: content,
-                context: [{ key: key, type: t.unknown }],
-                message: `The field ${key} is not part of the Custom type`,
-            };
-            return fp_ts_1.either.left([error]);
-        }
-        // retrieving the right codec then testing out fieldValue with it.
-        const { result, codec } = ImportField_1.ImportField.decode(model)(content);
-        // error.context is pointing at root when it should point to a `fieldKey`.
-        // We need to override the context to make it right.
-        if ((0, Either_1.isLeft)(result)) {
-            const errors = result.left.map((error) => {
-                const contextHead = error.context[0];
-                const context = [
-                    { key: "", actual: document, type: (0, exports.ImportDocument)(customType) },
-                    contextHead
-                        ? { ...contextHead, key: key }
-                        : { key: key, actual: content, type: codec },
-                    ...error.context.slice(1),
-                ];
-                return { ...error, context };
-            });
-            return fp_ts_1.either.left(errors);
-        }
-        return fp_ts_1.either.right(result.right);
-    };
-}
-function validateDocument(customType, rawDoc) {
-    const fieldModels = (0, customtypes_1.flattenCustomTypeFields)(customType);
-    const { document, errors } = Object.entries(rawDoc).reduce((acc, [fieldKey, fieldValue]) => {
-        const parsedField = validateField(rawDoc, customType)(fieldKey, fieldValue, fieldModels[fieldKey]);
-        if ((0, Either_1.isLeft)(parsedField))
-            return { ...acc, errors: [...acc.errors, ...parsedField.left] };
-        return {
-            ...acc,
-            document: { ...acc.document, [fieldKey]: parsedField.right },
-        };
-    }, { document: {}, errors: [] });
-    if (errors.length > 0)
-        return fp_ts_1.either.left(errors);
-    return fp_ts_1.either.right(document);
-}
-const ImportDocument = (customType) => new t.Type("ImportDocument", (u) => (0, Objects_1.isObject)(u), (raw) => {
-    return (0, function_1.pipe)(rawImportDocument.decode(raw), fp_ts_1.either.chain((doc) => validateDocument(customType, doc)));
-}, t.identity);
-exports.ImportDocument = ImportDocument;

package/lib/import/validators/fields/ImportContent.d.ts

@@ -1,5 +0,0 @@
-import * as t from "io-ts";
-export declare const ImportContent: <T extends "Boolean" | "Color" | "Date" | "Embed" | "GeoPoint" | "Image" | "IntegrationFields" | "Link" | "Number" | "Range" | "StructuredText" | "Select" | "Separator" | "Text" | "Timestamp" | "Group" | "Choice" | "Slices" | "UID", A, O = A>(type: T, valueCodec: t.Type<A, O, unknown>) => t.Type<{
-    type: T;
-    value: A;
-}, O, unknown>;

package/lib/import/validators/fields/ImportContent.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportContent = void 0;
-const tslib_1 = require("tslib");
-const fp_ts_1 = require("fp-ts");
-const function_1 = require("fp-ts/lib/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const Objects_1 = require("../../../utils/Objects");
-const ImportContent = (type, valueCodec) => new t.Type(`ImportField: ${valueCodec.name}`, (u) => {
-    if (!(0, Objects_1.isObject)(u))
-        return false;
-    return type === u["type"] && valueCodec.is(u["value"]);
-}, (u, c) => {
-    return (0, function_1.pipe)(valueCodec.validate(u, c), fp_ts_1.either.map((decodedValue) => {
-        return {
-            type,
-            value: decodedValue,
-        };
-    }));
-}, (field) => field.value);
-exports.ImportContent = ImportContent;

package/lib/import/validators/fields/ImportField.d.ts

@@ -1,141 +0,0 @@
-import type { StaticWidget } from "../../../customtypes";
-import { ImportGroup } from "./ImportGroup";
-import { ImportSlices } from "./ImportSlices";
-import { ImportNestable } from "./nestable";
-export declare type ImportField = ImportSlices | ImportNestable | ImportGroup;
-export declare const ImportField: {
-    is(u: unknown): u is ImportField;
-    decode: (field: StaticWidget) => (content: unknown) => {
-        codec: import("io-ts").Type<{
-            type: "Boolean";
-            value: boolean | null;
-        }, boolean | undefined, unknown> | import("io-ts").Type<{
-            type: "Color";
-            value: `#${string}` | null;
-        }, string | undefined, unknown> | import("io-ts").Type<{
-            type: "Date";
-            value: Date | null;
-        }, Date | undefined, unknown> | import("io-ts").Type<{
-            type: "Embed";
-            value: {
-                embed_url: string;
-            } | null;
-        }, {
-            embed_url: string;
-        } | undefined, unknown> | import("io-ts").Type<{
-            type: "GeoPoint";
-            value: {
-                latitude: number;
-                longitude: number;
-            } | null;
-        }, {
-            latitude: number;
-            longitude: number;
-        } | undefined, unknown> | import("io-ts").Type<{
-            type: "Image";
-            value: import("./nestable").ImageFieldWithThumbnails | null;
-        }, import("./nestable").ImageFieldWithThumbnails | undefined, unknown> | import("io-ts").Type<{
-            type: "Link";
-            value: ({
-                link_type: "Web";
-                url: string;
-            } & {
-                target?: string;
-            }) | {
-                link_type: "Document";
-                id: string;
-            } | {
-                link_type: "Media";
-                id: string;
-            } | null;
-        }, {
-            link_type: "Document" | "Web" | "Media";
-        } | undefined, unknown> | import("io-ts").Type<{
-            type: "StructuredText";
-            value: import("./nestable").ImportBlock[] | null;
-        }, import("./nestable").ImportBlock[] | undefined, unknown> | import("io-ts").Type<{
-            type: "Number";
-            value: number | null;
-        }, number | undefined, unknown> | import("io-ts").Type<{
-            type: "Select";
-            value: string | null;
-        }, string | undefined, unknown> | import("io-ts").Type<{
-            type: "Text";
-            value: string | null;
-        }, string | undefined, unknown> | import("io-ts").Type<{
-            type: "Timestamp";
-            value: Date | null;
-        }, Date | undefined, unknown>;
-        result: import("fp-ts/lib/Either").Left<import("io-ts").Errors> | import("fp-ts/lib/Either").Right<{
-            type: "Timestamp";
-            value: Date | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Text";
-            value: string | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Select";
-            value: string | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Number";
-            value: number | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "StructuredText";
-            value: import("./nestable").ImportBlock[] | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Link";
-            value: ({
-                link_type: "Web";
-                url: string;
-            } & {
-                target?: string;
-            }) | {
-                link_type: "Document";
-                id: string;
-            } | {
-                link_type: "Media";
-                id: string;
-            } | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Image";
-            value: import("./nestable").ImageFieldWithThumbnails | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "GeoPoint";
-            value: {
-                latitude: number;
-                longitude: number;
-            } | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Embed";
-            value: {
-                embed_url: string;
-            } | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Date";
-            value: Date | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Color";
-            value: `#${string}` | null;
-        }> | import("fp-ts/lib/Either").Right<{
-            type: "Boolean";
-            value: boolean | null;
-        }>;
-    } | {
-        codec: import("io-ts").Type<{
-            type: "Slices";
-            value: import("./ImportSlices/SharedSlice").SharedSlice[] | null;
-        }, import("./ImportSlices/SharedSlice").SharedSlice[] | undefined, unknown>;
-        result: import("io-ts").Validation<{
-            type: "Slices";
-            value: import("./ImportSlices/SharedSlice").SharedSlice[] | null;
-        }>;
-    } | {
-        codec: import("io-ts").Type<{
-            type: "Group";
-            value: import("./RepeatableZoneItem").RepeatableZoneItem[] | null;
-        }, import("./RepeatableZoneItem").RepeatableZoneItem[] | undefined, unknown>;
-        result: import("io-ts").Validation<{
-            type: "Group";
-            value: import("./RepeatableZoneItem").RepeatableZoneItem[] | null;
-        }>;
-    };
-};

package/lib/import/validators/fields/ImportField.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportField = void 0;
-const ImportGroup_1 = require("./ImportGroup");
-const ImportSlices_1 = require("./ImportSlices");
-const nestable_1 = require("./nestable");
-exports.ImportField = {
-    is(u) {
-        return exports.ImportField.is(u);
-    },
-    decode: (field) => {
-        return (content) => {
-            switch (field.type) {
-                case "UID":
-                    throw new Error(`The field '${field.type}' should be put at the root level of the document`);
-                case "Slices":
-                    return {
-                        codec: (0, ImportSlices_1.ImportSlices)(field),
-                        result: (0, ImportSlices_1.ImportSlices)(field).decode(content),
-                    };
-                case "Group":
-                    return {
-                        codec: (0, ImportGroup_1.ImportGroup)(field),
-                        result: (0, ImportGroup_1.ImportGroup)(field).decode(content),
-                    };
-                case "Choice":
-                    throw new Error(`Unsupported type of field ${field.type}`);
-                default:
-                    return nestable_1.ImportNestable.decode(field)(content);
-            }
-        };
-    },
-};

package/lib/import/validators/fields/ImportGroup.d.ts

@@ -1,345 +0,0 @@
-import * as t from "io-ts";
-export declare const ImportGroupValue: (groupCustomType?: ({
-    type: "Group";
-} & {
-    fieldset?: string | null | undefined;
-    icon?: string;
-    description?: string;
-    config?: {
-        label?: string | null | undefined;
-        repeat?: boolean;
-        fields?: {
-            [x: string]: ({
-                type: "Boolean";
-            } & {
-                config?: {
-                    label?: string | null | undefined;
-                    default_value?: boolean;
-                    placeholder_true?: string;
-                    placeholder_false?: string;
-                };
-            }) | ({
-                type: "Color";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                };
-            }) | ({
-                type: "Date";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    default?: string;
-                };
-            }) | ({
-                type: "Embed";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    useAsTitle?: boolean;
-                };
-            }) | ({
-                type: "GeoPoint";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                };
-            }) | ({
-                type: "Image";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    constraint?: {
-                        width?: number | null;
-                        height?: number | null;
-                    };
-                    thumbnails?: readonly ({
-                        name: string;
-                    } & {
-                        width?: number | null;
-                        height?: number | null;
-                    })[];
-                };
-            }) | ({
-                type: "IntegrationFields";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    catalog?: string;
-                };
-            }) | ({
-                type: "Link";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    useAsTitle?: boolean;
-                    placeholder?: string;
-                    select?: "media" | "document" | "web" | null;
-                    customtypes?: readonly string[];
-                    masks?: readonly string[];
-                    tags?: readonly string[];
-                    allowTargetBlank?: boolean;
-                };
-            }) | ({
-                type: "Number";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    min?: number;
-                    max?: number;
-                    step?: number;
-                };
-            }) | ({
-                type: "Range";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    min?: number;
-                    max?: number;
-                    step?: number;
-                };
-            }) | ({
-                type: "StructuredText";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    useAsTitle?: boolean;
-                    single?: string;
-                    multi?: string;
-                    imageConstraint?: {
-                        width?: number | null;
-                        height?: number | null;
-                    };
-                    labels?: readonly string[];
-                    allowTargetBlank?: boolean;
-                };
-            }) | ({
-                type: "Select";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    default_value?: string;
-                    options?: readonly string[];
-                };
-            }) | ({
-                type: "Separator";
-            } & {
-                config?: {
-                    label?: string | null | undefined;
-                };
-            }) | ({
-                type: "Text";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    useAsTitle?: boolean;
-                    placeholder?: string;
-                };
-            }) | ({
-                type: "Timestamp";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    default?: string;
-                };
-            });
-        };
-    };
-}) | undefined) => t.Type<import("./RepeatableZoneItem").RepeatableZoneItem[], import("./RepeatableZoneItem").RepeatableZoneItem[], unknown>;
-export declare const ImportGroup: (groupCustomType?: ({
-    type: "Group";
-} & {
-    fieldset?: string | null | undefined;
-    icon?: string;
-    description?: string;
-    config?: {
-        label?: string | null | undefined;
-        repeat?: boolean;
-        fields?: {
-            [x: string]: ({
-                type: "Boolean";
-            } & {
-                config?: {
-                    label?: string | null | undefined;
-                    default_value?: boolean;
-                    placeholder_true?: string;
-                    placeholder_false?: string;
-                };
-            }) | ({
-                type: "Color";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                };
-            }) | ({
-                type: "Date";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    default?: string;
-                };
-            }) | ({
-                type: "Embed";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    useAsTitle?: boolean;
-                };
-            }) | ({
-                type: "GeoPoint";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                };
-            }) | ({
-                type: "Image";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    constraint?: {
-                        width?: number | null;
-                        height?: number | null;
-                    };
-                    thumbnails?: readonly ({
-                        name: string;
-                    } & {
-                        width?: number | null;
-                        height?: number | null;
-                    })[];
-                };
-            }) | ({
-                type: "IntegrationFields";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    catalog?: string;
-                };
-            }) | ({
-                type: "Link";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    useAsTitle?: boolean;
-                    placeholder?: string;
-                    select?: "media" | "document" | "web" | null;
-                    customtypes?: readonly string[];
-                    masks?: readonly string[];
-                    tags?: readonly string[];
-                    allowTargetBlank?: boolean;
-                };
-            }) | ({
-                type: "Number";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    min?: number;
-                    max?: number;
-                    step?: number;
-                };
-            }) | ({
-                type: "Range";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    min?: number;
-                    max?: number;
-                    step?: number;
-                };
-            }) | ({
-                type: "StructuredText";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    useAsTitle?: boolean;
-                    single?: string;
-                    multi?: string;
-                    imageConstraint?: {
-                        width?: number | null;
-                        height?: number | null;
-                    };
-                    labels?: readonly string[];
-                    allowTargetBlank?: boolean;
-                };
-            }) | ({
-                type: "Select";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    default_value?: string;
-                    options?: readonly string[];
-                };
-            }) | ({
-                type: "Separator";
-            } & {
-                config?: {
-                    label?: string | null | undefined;
-                };
-            }) | ({
-                type: "Text";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    useAsTitle?: boolean;
-                    placeholder?: string;
-                };
-            }) | ({
-                type: "Timestamp";
-            } & {
-                fieldset?: string | null | undefined;
-                config?: {
-                    label?: string | null | undefined;
-                    placeholder?: string;
-                    default?: string;
-                };
-            });
-        };
-    };
-}) | undefined) => t.Type<{
-    type: "Group";
-    value: import("./RepeatableZoneItem").RepeatableZoneItem[] | null;
-}, import("./RepeatableZoneItem").RepeatableZoneItem[] | undefined, unknown>;
-export declare type ImportGroup = t.TypeOf<ReturnType<typeof ImportGroup>>;

package/lib/import/validators/fields/ImportGroup.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportGroup = exports.ImportGroupValue = void 0;
-const tslib_1 = require("tslib");
-const E = (0, tslib_1.__importStar)(require("fp-ts/Either"));
-const function_1 = require("fp-ts/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const validators_1 = require("../../../validators");
-const function_2 = require("../../../validators/function");
-const ImportContent_1 = require("./ImportContent");
-const RepeatableZone_1 = require("./RepeatableZone");
-const ImportGroupValue = (groupCustomType) => {
-    var _a, _b;
-    const fieldsModel = (_b = (_a = groupCustomType === null || groupCustomType === void 0 ? void 0 : groupCustomType.config) === null || _a === void 0 ? void 0 : _a.fields) !== null && _b !== void 0 ? _b : {};
-    const groupArrayCodec = (0, RepeatableZone_1.RepeatableZone)(fieldsModel);
-    return (0, function_2.withCustomError)(new t.Type(groupArrayCodec.name, groupArrayCodec.is, (u, c) => (0, function_1.pipe)(groupArrayCodec.validate(u, c), E.chain((groups) => {
-        var _a;
-        if (((_a = groupCustomType === null || groupCustomType === void 0 ? void 0 : groupCustomType.config) === null || _a === void 0 ? void 0 : _a.repeat) === false &&
-            groups.length > 1) {
-            return t.failure(groups, c, "The custom type for this group field does not allow multiple group items");
-        }
-        return t.success(groups);
-    })), t.identity), () => "The group field value must be an array");
-};
-exports.ImportGroupValue = ImportGroupValue;
-const ImportGroup = (groupCustomType) => (0, ImportContent_1.ImportContent)("Group", (0, validators_1.EmptyArrayOrElse)((0, exports.ImportGroupValue)(groupCustomType)));
-exports.ImportGroup = ImportGroup;

package/lib/import/validators/fields/ImportSlices/ImportSlices.d.ts

@@ -1,8 +0,0 @@
-import * as t from "io-ts";
-import type { StaticSlices } from "../../../../customtypes";
-import { SharedSlice } from "./SharedSlice";
-export declare const ImportSlices: (staticSlices: StaticSlices) => t.Type<{
-    type: "Slices";
-    value: SharedSlice[] | null;
-}, SharedSlice[] | undefined, unknown>;
-export declare type ImportSlices = t.TypeOf<ReturnType<typeof ImportSlices>>;

package/lib/import/validators/fields/ImportSlices/ImportSlices.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportSlices = void 0;
-const tslib_1 = require("tslib");
-const E = (0, tslib_1.__importStar)(require("fp-ts/Either"));
-const function_1 = require("fp-ts/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const validators_1 = require("../../../../validators");
-const ImportContent_1 = require("../ImportContent");
-const SharedSlice_1 = require("./SharedSlice");
-const utils_1 = require("./utils");
-const ImportSlices = (staticSlices) => {
-    const supportedSlices = (0, utils_1.extractSupportedSlices)(staticSlices);
-    // For now we only support the SharedSlice, however if we want to support more in the future
-    // we would have to change the codec here to something like this: t.array(t.union([ImportSharedSlice(sharedSlices), NewSliceCodec(newSliceCustomTypes)])).
-    const SharedSliceCodec = (0, SharedSlice_1.SharedSlice)(supportedSlices);
-    const SlicesArrayCodec = t.array(SharedSliceCodec);
-    return (0, ImportContent_1.ImportContent)("Slices", (0, validators_1.EmptyArrayOrElse)(new t.ArrayType(SlicesArrayCodec.name, (u) => SlicesArrayCodec.is(u), (u, c) => {
-        return (0, function_1.pipe)(SlicesArrayCodec.validate(u, c), E.chain((slices) => {
-            // This part might not make sense for all Slice types in the future, but for now we only support the SharedSlice
-            // In case we support more in the future, we would have to filter only the relevant type for this check
-            const sharedSliceDuplicates = (0, utils_1.findImportSharedSliceDuplicateIds)(slices);
-            if (sharedSliceDuplicates.length > 0) {
-                return t.failure(slices, [], `Duplicate slice IDs detected: ${sharedSliceDuplicates.join(", ")}`);
-            }
-            return t.success(slices);
-        }));
-    }, t.identity, SharedSliceCodec)));
-};
-exports.ImportSlices = ImportSlices;