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

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

@@ -1,2 +0,0 @@
-import * as t from "io-ts";
-export declare const OptionalSharedSliceId: t.Type<string | null | undefined, string | null | undefined, unknown>;

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

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OptionalSharedSliceId = void 0;
-const tslib_1 = require("tslib");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const SharedSliceId_1 = require("./SharedSliceId");
-// Wrapping the 'SharedSliceId' codec in an optional codec here for the sake of error reporting.
-// When using t.union([t.undefined, t.null, SharedSliceId]) we get a nested error context
-// with the actual decoding error at position 2 in the context array.
-// To avoid mutating the error context we create this new wrapper codec so that  the error context will always have desired depth.
-exports.OptionalSharedSliceId = new t.Type("OptionalSharedSliceId", (u) => u === null || u === undefined || SharedSliceId_1.SharedSliceId.is(u), (u, c) => {
-    if (u === null || u === undefined)
-        return t.success(u);
-    return SharedSliceId_1.SharedSliceId.validate(u, c);
-}, t.identity);

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

@@ -1,17 +0,0 @@
-import * as t from "io-ts";
-import { WidgetKey } from "../../../../../../../common";
-import type { NestableWidget } from "../../../../../../../customtypes";
-import type { ImportNestable } from "../../../../nestable";
-/**
- * Represents the object in the 'primary' field or a single item in the 'items' array in the SharedSlice.
- */
-export declare type SharedSliceContent = Record<WidgetKey, ImportNestable>;
-/**
- * Builds the decoder for a single entry in the 'primary' field or a single item in the 'items' array in the SharedSlice.
- *
- * @param sliceName name of the slice - used for error reporting in order to know which slice is being decoded
- * @param sliceContentField 'primary' or 'items' - used for error reporting in order to know which field of the slice is being decoded
- * @param sliceFieldModels models of the fields of the slice from custom type - used to know which codec to use for decoding each value of the object
- * @constructor
- */
-export declare const SharedSliceContent: (sliceName: string, sliceContentField: "primary" | "items", sliceFieldModels: Record<WidgetKey, NestableWidget>) => t.Type<SharedSliceContent, SharedSliceContent, unknown>;

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

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedSliceContent = void 0;
-const tslib_1 = require("tslib");
-const E = (0, tslib_1.__importStar)(require("fp-ts/Either"));
-const function_1 = require("fp-ts/lib/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const common_1 = require("../../../../../../../common");
-const io_ts_1 = require("../../../../../../../utils/io-ts");
-const function_2 = require("../../../../../../../validators/function");
-const SharedSliceContentEntry_1 = require("./SharedSliceContentEntry");
-/**
- * Builds the decoder for a single entry in the 'primary' field or a single item in the 'items' array in the SharedSlice.
- *
- * @param sliceName name of the slice - used for error reporting in order to know which slice is being decoded
- * @param sliceContentField 'primary' or 'items' - used for error reporting in order to know which field of the slice is being decoded
- * @param sliceFieldModels models of the fields of the slice from custom type - used to know which codec to use for decoding each value of the object
- * @constructor
- */
-const SharedSliceContent = (sliceName, sliceContentField, sliceFieldModels) => new t.Type("SharedSliceContent", (u) => t.record(common_1.WidgetKey, t.unknown).is(u), (u, c) => (0, function_1.pipe)(
-// We first decode the raw content object in the shape of Record<WidgetKey, unknown>
-(0, function_2.withCustomError)(t.UnknownRecord, () => "The value must be an object").validate(u, c), E.chain((rawContent) => (0, function_1.pipe)(
-// We split the object into entries because there is no easy other way to decode each value with a different codec
-Object.entries(rawContent).map((entry) => (0, SharedSliceContentEntry_1.SharedSliceContentEntry)(sliceName, sliceContentField, sliceFieldModels).validate(entry, c)), 
-// We get a validation result for each entry in the content object (t.Validation<SharedSliceContentEntry>[]),
-// however we want to get a single validation result for the whole array of entries (t.Validation<SharedSliceContentEntry[]>).
-io_ts_1.combineValidationResults, 
-// We build the object back from entries if all decoded successfully
-E.map((entries) => entries.reduce((acc, [key, value]) => ({ ...acc, [key]: value }), {}))))), t.identity);
-exports.SharedSliceContent = SharedSliceContent;

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/SharedSliceContentEntry.d.ts

@@ -1,43 +0,0 @@
-import * as t from "io-ts";
-import { WidgetKey } from "../../../../../../../common";
-import type { NestableWidget } from "../../../../../../../customtypes";
-import { ImportNestable } from "../../../../nestable";
-export declare type SharedSliceContentEntry = [WidgetKey, ImportNestable];
-/**
- * Represents a single entry in the 'primary' field or a single entry in an item in the 'items' array in the SharedSlice. It is used to build the SharedSliceContent type from entries of the import object.
- *
- * For example, given the following slice:
- * 	{
- *  	"slice_type": "my_slice",
- *  	"variation": "default",
- *      "primary": {
- *      	"slice_text": "abc", // This is one entry
- *          "slice_text2": "def: // This is another entry
- *       },
- *       "items": [
- *       	   {
- *             		"slice_number1": 0, // This is one entry
- *             		"slice_number2": 1	// And this is yet another entry
- *             }
- *       ]
- *  }
- *
- *  The 'primary' object is converted to following entries to be decoded:
- *  [
- *      ["slice_text", "abc"],
- *      ["slice_text2", "def"]
- *  ]
- *  and the first item in the 'items' array is converted to following entries to be decoded:
- *  [
- *    ["slice_number1", 0],
- *    ["slice_number2", 1]
- *  ]
- *
- *  We decode them as separate entries because each of the values might require a different codec as per what is specified in the SharedSlice custom type.
- *  In this way we save on the decoding performance in comparison to a scenario where we would decode the whole content object as a record with a union type decoder for each value.
- *
- *  @param sliceName name of the slice - used for error reporting in order to know which slice is being decoded
- *  @param sliceContentField 'primary' or 'items' - used for error reporting in order to know which field of the slice is being decoded
- *  @param sliceFieldModels models of the fields of the slice from custom type - used to know which codec to use for decoding each value of the object
- */
-export declare const SharedSliceContentEntry: (sliceName: string, sliceContentField: "primary" | "items", sliceFieldModels: Record<WidgetKey, NestableWidget>) => t.Type<SharedSliceContentEntry, SharedSliceContentEntry, unknown>;

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/SharedSliceContentEntry.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedSliceContentEntry = 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 common_1 = require("../../../../../../../common");
-const nestable_1 = require("../../../../nestable");
-const errors_1 = require("./errors");
-/**
- * Represents a single entry in the 'primary' field or a single entry in an item in the 'items' array in the SharedSlice. It is used to build the SharedSliceContent type from entries of the import object.
- *
- * For example, given the following slice:
- * 	{
- *  	"slice_type": "my_slice",
- *  	"variation": "default",
- *      "primary": {
- *      	"slice_text": "abc", // This is one entry
- *          "slice_text2": "def: // This is another entry
- *       },
- *       "items": [
- *       	   {
- *             		"slice_number1": 0, // This is one entry
- *             		"slice_number2": 1	// And this is yet another entry
- *             }
- *       ]
- *  }
- *
- *  The 'primary' object is converted to following entries to be decoded:
- *  [
- *      ["slice_text", "abc"],
- *      ["slice_text2", "def"]
- *  ]
- *  and the first item in the 'items' array is converted to following entries to be decoded:
- *  [
- *    ["slice_number1", 0],
- *    ["slice_number2", 1]
- *  ]
- *
- *  We decode them as separate entries because each of the values might require a different codec as per what is specified in the SharedSlice custom type.
- *  In this way we save on the decoding performance in comparison to a scenario where we would decode the whole content object as a record with a union type decoder for each value.
- *
- *  @param sliceName name of the slice - used for error reporting in order to know which slice is being decoded
- *  @param sliceContentField 'primary' or 'items' - used for error reporting in order to know which field of the slice is being decoded
- *  @param sliceFieldModels models of the fields of the slice from custom type - used to know which codec to use for decoding each value of the object
- */
-const SharedSliceContentEntry = (sliceName, sliceContentField, sliceFieldModels) => new t.Type("SharedSliceContentEntry", (u) => t.tuple([common_1.WidgetKey, t.unknown]).is(u) && nestable_1.ImportNestable.is(u[1]), (u, c) => {
-    return (0, function_1.pipe)(t.tuple([common_1.WidgetKey, t.unknown]).validate(u, c), E.chain(([key, content]) => {
-        const model = sliceFieldModels[key];
-        if (!model) {
-            return t.failure([key, content], [...c, { key, actual: content, type: t.unknown }], errors_1.SharedSliceContentErrors.UnknownField(sliceName, sliceContentField, key));
-        }
-        const { codec, result } = nestable_1.ImportNestable.decode(model)(content);
-        return (0, function_1.pipe)(result, E.map((decodedContent) => [
-            key,
-            decodedContent,
-        ]), E.mapLeft((errors) => errors.map((error) => {
-            const context = [
-                ...c,
-                { key, actual: content, type: codec },
-                ...error.context.slice(1), // We ignore the first context element with "" key coming from ImportNestable decoder
-            ];
-            const updatedError = { ...error, context };
-            return updatedError;
-        })));
-    }));
-}, t.identity);
-exports.SharedSliceContentEntry = SharedSliceContentEntry;

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/errors.d.ts

@@ -1,4 +0,0 @@
-import type { SharedSliceContentField } from "./types";
-export declare const SharedSliceContentErrors: {
-    readonly UnknownField: (sliceName: string, contentField: SharedSliceContentField, fieldName: string) => string;
-};

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/errors.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedSliceContentErrors = void 0;
-exports.SharedSliceContentErrors = {
-    UnknownField: (sliceName, contentField, fieldName) => `Unsupported field '${fieldName}'for '${contentField}' content in Shared Slice '${sliceName}'`,
-};

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./errors";
-export * from "./SharedSliceContent";

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./errors"), exports);
-(0, tslib_1.__exportStar)(require("./SharedSliceContent"), exports);

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/types.d.ts

@@ -1 +0,0 @@
-export declare type SharedSliceContentField = "primary" | "items";

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,9 +0,0 @@
-import * as t from "io-ts";
-import { UUID } from "../../../../../../common/UUID";
-export declare type SharedSliceId = `${string}$${UUID}`;
-export declare const SharedSliceIdValidationError: {
-    readonly Base: "Slice id must be a non empty string matching the following pattern 'slice_type$uuid'";
-    readonly IncorrectUUID: (uuid: string | undefined) => string;
-    readonly IncorrectSliceType: (sliceType: string | undefined) => string;
-};
-export declare const SharedSliceId: t.Type<string, string, unknown>;

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

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedSliceId = exports.SharedSliceIdValidationError = 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 UUID_1 = require("../../../../../../common/UUID");
-const validators_1 = require("../../../../../../validators");
-const baseErrorText = "Slice id must be a non empty string matching the following pattern 'slice_type$uuid'";
-exports.SharedSliceIdValidationError = {
-    Base: baseErrorText,
-    IncorrectUUID: (uuid) => `Incorrect UUID: '${uuid}' - ${baseErrorText}`,
-    IncorrectSliceType: (sliceType) => `Incorrect slice_type: '${sliceType}' - ${baseErrorText}`,
-};
-exports.SharedSliceId = new t.Type("SharedSliceId", (u) => {
-    if (typeof u !== "string") {
-        return false;
-    }
-    const [sliceName, uuid] = u.split("$");
-    return validators_1.NonEmptyString.is(sliceName) && UUID_1.UUID.is(uuid);
-}, (u, c) => (0, function_1.pipe)(validators_1.NonEmptyString.validate(u, c), E.mapLeft((errors) => errors.map((error) => ({
-    ...error,
-    message: exports.SharedSliceIdValidationError.Base,
-}))), E.chain((sliceId) => {
-    const [sliceName, uuid] = sliceId.split("$");
-    return (0, function_1.pipe)(t.tuple([validators_1.NonEmptyString, UUID_1.UUID]).validate([sliceName, uuid], c), E.mapLeft((errors) => errors.map((error) => {
-        const tupleErrorContext = error.context[error.context.length - 1];
-        return {
-            ...error,
-            context: [
-                ...error.context.slice(0, -1), // We don't want the tuple decoder error context
-            ],
-            message: (tupleErrorContext === null || tupleErrorContext === void 0 ? void 0 : tupleErrorContext.key) === "0"
-                ? exports.SharedSliceIdValidationError.IncorrectSliceType(sliceName)
-                : exports.SharedSliceIdValidationError.IncorrectUUID(uuid),
-        };
-    })));
-}), E.map(([sliceName, uuid]) => `${sliceName}$${uuid}`)), (sliceId) => sliceId);

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

@@ -1,11 +0,0 @@
-import * as t from "io-ts";
-import { SharedSlice as SharedSliceCustomType } from "../../../../../../customtypes";
-export declare type SharedSliceType = {
-    slice_type: string;
-    data: SharedSliceCustomType;
-};
-/**
- * Builds the decoder for the 'slice_type' field in the SharedSlice. Alongside the decoded 'slice_type' it also returns the SharedSlice data matching the slice_type.
- * @param slices all the SharedSlices from the custom type
- */
-export declare const SharedSliceType: (slices: SharedSliceCustomType[]) => t.Type<SharedSliceType, string, unknown>;

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

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedSliceType = 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 customtypes_1 = require("../../../../../../customtypes");
-const validators_1 = require("../../../../../../validators");
-const utils_1 = require("../utils");
-/**
- * slice_type - the validated slice_type
- * slice - SharedSlice custom type data matching the slice_type. We return it alongside the validated slice_type, because it is needed to decode the 'variation' field in the SharedSlice (see SharedSliceVariation.ts)
- */
-const SharedSliceTypeShape = t.strict({
-    slice_type: validators_1.NonEmptyString,
-    slice: customtypes_1.SharedSlice,
-});
-/**
- * Builds the decoder for the 'slice_type' field in the SharedSlice. Alongside the decoded 'slice_type' it also returns the SharedSlice data matching the slice_type.
- * @param slices all the SharedSlices from the custom type
- */
-const SharedSliceType = (slices) => new t.Type("slice_type", (u) => SharedSliceTypeShape.is(u), (u, c) => (0, function_1.pipe)(validators_1.NonEmptyString.validate(u, c), E.chain((slice_type) => (0, function_1.pipe)((0, utils_1.findSlice)(slices)(slice_type), E.fold((err) => t.failure(u, c, err), (data) => t.success({ slice_type, data }))))), ({ slice_type }) => slice_type);
-exports.SharedSliceType = SharedSliceType;

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

@@ -1,11 +0,0 @@
-import * as t from "io-ts";
-import { SharedSlice, Variation } from "../../../../../../customtypes";
-export declare type SharedSliceVariation = {
-    variation: string;
-    data: Variation;
-};
-/**
- * Builds the decoder for the 'variation' field in the SharedSlice. Alongside the decoded 'variation' it also returns the Variation data matching the variation custom type.
- * @param slice SharedSlice from the custom type
- */
-export declare const SharedSliceVariation: (slice: SharedSlice) => t.Type<SharedSliceVariation, string, unknown>;

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

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedSliceVariation = 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 customtypes_1 = require("../../../../../../customtypes");
-const validators_1 = require("../../../../../../validators");
-const utils_1 = require("../utils");
-/**
- * variation - the validated variation of the slice
- * data - Variation data matching the variation. We return it alongside the validated variation, because it is needed to decode the 'primary' and 'items' fields in the SharedSlice.
- */
-const SharedSliceVariationShape = t.strict({
-    variation: validators_1.NonEmptyString,
-    data: customtypes_1.Variation,
-});
-/**
- * Builds the decoder for the 'variation' field in the SharedSlice. Alongside the decoded 'variation' it also returns the Variation data matching the variation custom type.
- * @param slice SharedSlice from the custom type
- */
-const SharedSliceVariation = (slice) => new t.Type("variation", (u) => SharedSliceVariationShape.is(u), (u, c) => (0, function_1.pipe)(validators_1.NonEmptyString.validate(u, c), E.chain((variation) => (0, function_1.pipe)((0, utils_1.findSliceVariation)(slice)(variation), E.fold((err) => t.failure(u, c, err), (data) => t.success({ variation, data }))))), ({ variation }) => variation);
-exports.SharedSliceVariation = SharedSliceVariation;

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

@@ -1,4 +0,0 @@
-export * from "./OptionalSharedSliceId";
-export * from "./SharedSliceId";
-export * from "./SharedSliceType";
-export * from "./SharedSliceVariation";

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

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./OptionalSharedSliceId"), exports);
-(0, tslib_1.__exportStar)(require("./SharedSliceId"), exports);
-(0, tslib_1.__exportStar)(require("./SharedSliceType"), exports);
-(0, tslib_1.__exportStar)(require("./SharedSliceVariation"), exports);

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

@@ -1,3 +0,0 @@
-export * from "./errors";
-export * from "./fields";
-export * from "./SharedSlice";

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

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./errors"), exports);
-(0, tslib_1.__exportStar)(require("./fields"), exports);
-(0, tslib_1.__exportStar)(require("./SharedSlice"), exports);