@prismicio/types-internal 3.17.0-pr.145.680cd65 → 3.17.2

package/README.md

@@ -1,35 +1,18 @@
-<!--
-
-TODO: Go through all "TODO" comments in the project
-
-TODO: Replace all on all files (README.md, CONTRIBUTING.md, bug_report.md, package.json):
-- @prismicio/types-internal
-- Prismic internal types for content and models
-- prismicio
-- prismic-types-internal
-
--->
+> [!NOTE]
+> This repository is for `@prismicio/types-internal` v3.
+>
+> v4 development and onward is happening at [prismicio/prismic-types-internal](https://github.dev/prismicio/prismic-types-internal)
 
 # @prismicio/types-internal
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
+[![Codecov][codecov-src]][codecov-href]
+[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
+[![License][license-src]][license-href]
 
-<!-- TODO: Replacing link to Prismic with [Prismic][prismic] is useful here -->
-
-Prismic internal types for content and models.
-
-<!--
-
-TODO: Create a small list of package features:
-
-- 🤔 &nbsp;A useful feature;
-- 🥴 &nbsp;Another useful feature;
-- 🙃 &nbsp;A final useful feature.
-
-Non-breaking space: &nbsp; are here on purpose to fix emoji rendering on certain systems.
-
--->
+A library that provides TypeScript types and runtime parsers for Prismic data. It handles models and content in the editor format. It is used in many Prismic TypeScript packages.
 
 ## Install
 
@@ -39,32 +22,30 @@ npm install @prismicio/types-internal
 
 ## Documentation
 
-To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
+To discover what's new on this package check out [the changelog][changelog].
 
 ## Contributing
 
 Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!
 
-**Asking a question**: [Open a new topic][forum-question] on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.
-
 **Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.
 
 **Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.
 
 **Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
 
-For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document.
+For more clarity on this project, check out the detailed [CONTRIBUTING.md][contributing] document.
 
 ## License
 
 ```
-Copyright 2013-2026 Prismic <contact@prismic.io> (https://prismic.io)
+Copyright 2013-2024 Prismic <contact@prismic.io> (https://prismic.io)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-http://www.apache.org/licenses/LICENSE-2.0
+    http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -86,9 +67,9 @@ limitations under the License.
 <!-- TODO: Replace link with a more useful one if available -->
 
 [forum-question]: https://community.prismic.io
-[repo-bug-report]: https://github.com/prismicio/prismic-types-internal/issues/new?assignees=&labels=bug&template=bug_report.md&title=
-[repo-feature-request]: https://github.com/prismicio/prismic-types-internal/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
-[repo-pull-requests]: https://github.com/prismicio/prismic-types-internal/pulls
+[repo-bug-report]: https://github.com/prismicio/@prismicio/types-internal/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[repo-feature-request]: https://github.com/prismicio/@prismicio/types-internal/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[repo-pull-requests]: https://github.com/prismicio/@prismicio/types-internal/pulls
 
 <!-- Badges -->
 
@@ -96,3 +77,11 @@ limitations under the License.
 [npm-version-href]: https://npmjs.com/package/@prismicio/types-internal
 [npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/types-internal.svg
 [npm-downloads-href]: https://npmjs.com/package/@prismicio/types-internal
+[github-actions-ci-src]: https://github.com/prismicio/prismic-types-internal/workflows/ci/badge.svg
+[github-actions-ci-href]: https://github.com/prismicio/prismic-types-internal/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/@prismicio/types-internal.svg
+[codecov-href]: https://codecov.io/gh/prismicio/@prismicio/types-internal
+[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+[conventional-commits-href]: https://conventionalcommits.org
+[license-src]: https://img.shields.io/npm/l/@prismicio/types-internal.svg
+[license-href]: https://npmjs.com/package/@prismicio/types-internal

package/lib/common/Asset.d.ts

@@ -0,0 +1,16 @@
+export declare type Asset = {
+    id: string;
+    last_modified: string;
+    kind: "image" | "all";
+    filename?: string;
+    extension?: string;
+    size?: number;
+    origin_url: string;
+    url: string;
+    width?: number;
+    height?: number;
+    notes?: string;
+    credits?: string;
+    alt?: string;
+};
+export declare const getAssetOrThrow: (assets: Record<Asset["id"], Asset | undefined>) => (assetId: Asset["id"]) => Asset;

package/lib/common/Asset.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAssetOrThrow = void 0;
+const getAssetOrThrow = (assets) => (assetId) => {
+    const asset = assets[assetId];
+    if (!asset) {
+        throw new Error(`Missing asset with id '${assetId}'!`);
+    }
+    return asset;
+};
+exports.getAssetOrThrow = getAssetOrThrow;

package/lib/common/Embed.d.ts

@@ -0,0 +1,15 @@
+export declare type Embed = {
+    type: string;
+    version?: string | null;
+    author_name?: string | null;
+    author_url?: string | null;
+    provider_name?: string | null;
+    provider_url?: string | null;
+    cache_age?: string | null;
+    thumbnail_url?: string | null;
+    thumbnail_width?: number | null;
+    thumbnail_height?: number | null;
+    html?: string | null;
+    title?: string | null;
+};
+export declare const getEmbedOrThrow: (embeds: Record<string, Embed | undefined>) => (embedUrl: string) => Embed;

package/lib/common/Embed.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEmbedOrThrow = void 0;
+const getEmbedOrThrow = (embeds) => (embedUrl) => {
+    const embed = embeds[embedUrl];
+    if (!embed)
+        throw new Error(`Missing embed with url '${embedUrl}'`);
+    return embed;
+};
+exports.getEmbedOrThrow = getEmbedOrThrow;

package/lib/common/HexaColorCode.d.ts

@@ -0,0 +1,4 @@
+export declare type HexaColorCode = `#${string}`;
+export declare const HexaColor: {
+    is: (strColor: string) => strColor is `#${string}`;
+};

package/lib/common/HexaColorCode.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HexaColor = void 0;
+const hexaColorCodeRegex = /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/;
+exports.HexaColor = {
+    is: (strColor) => hexaColorCodeRegex.test(strColor),
+};

package/lib/common/UUID.d.ts

@@ -0,0 +1,6 @@
+import * as t from "io-ts";
+export interface UUIDBrand {
+    readonly UUID: unique symbol;
+}
+export declare const UUID: t.BrandC<t.StringC, UUIDBrand>;
+export declare type UUID = t.TypeOf<typeof UUID>;

package/lib/common/UUID.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UUID = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const uuid_1 = require("uuid");
+const function_1 = require("../validators/function");
+exports.UUID = (0, function_1.withCustomError)(t.brand(t.string, (s) => (0, uuid_1.validate)(s), "UUID"), () => "The value must be a valid UUID");

package/lib/common/WidgetKey.d.ts

@@ -0,0 +1,3 @@
+import * as t from "io-ts";
+export declare const WidgetKey: t.Type<string, string, unknown>;
+export declare type WidgetKey = t.TypeOf<typeof WidgetKey>;

package/lib/common/WidgetKey.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WidgetKey = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const function_1 = require("../validators/function");
+const widgetKeyRegex = new RegExp("^[^<>]+$");
+exports.WidgetKey = (0, function_1.refineType)(t.string, "WidgetKey", (s) => s.length === 0 || widgetKeyRegex.test(s));

package/lib/common/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Asset";
+export * from "./Embed";
+export * from "./WidgetKey";

package/lib/common/index.js

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