@byline/core 3.20.4 → 4.0.0

package/dist/codegen/fixtures/all-fields.d.ts

@@ -0,0 +1,342 @@
+export declare const QuoteBlock: {
+    readonly blockType: "quote'block";
+    readonly fields: readonly [{
+        readonly name: "quotation";
+        readonly type: "textArea";
+        readonly localized: true;
+    }, {
+        readonly name: "tone'choice";
+        readonly type: "select";
+        readonly optional: true;
+        readonly options: [{
+            readonly label: "Calm";
+            readonly value: "calm";
+        }, {
+            readonly label: "Quoted";
+            readonly value: "author's";
+        }];
+    }];
+};
+export declare const MediaBlock: {
+    readonly blockType: "media";
+    readonly fields: readonly [{
+        readonly name: "caption";
+        readonly type: "text";
+        readonly localized: true;
+        readonly optional: true;
+    }, {
+        readonly name: "image";
+        readonly type: "image";
+    }];
+};
+export declare const AllFieldsCollection: {
+    readonly path: "all-fields";
+    readonly labels: {
+        readonly singular: "All fields";
+        readonly plural: "All fields";
+    };
+    readonly fields: [{
+        readonly name: "integer";
+        readonly type: "integer";
+    }, {
+        readonly name: "float";
+        readonly type: "float";
+    }, {
+        readonly name: "counter";
+        readonly type: "counter";
+        readonly group: "fixture";
+    }, {
+        readonly name: "decimal";
+        readonly type: "decimal";
+    }, {
+        readonly name: "date";
+        readonly type: "date";
+    }, {
+        readonly name: "datetime";
+        readonly type: "datetime";
+    }, {
+        readonly name: "time";
+        readonly type: "time";
+    }, {
+        readonly name: "text";
+        readonly type: "text";
+    }, {
+        readonly name: "localizedText";
+        readonly type: "text";
+        readonly localized: true;
+    }, {
+        readonly name: "textArea";
+        readonly type: "textArea";
+    }, {
+        readonly name: "boolean";
+        readonly type: "boolean";
+    }, {
+        readonly name: "checkbox";
+        readonly type: "checkbox";
+    }, {
+        readonly name: "select";
+        readonly type: "select";
+        readonly options: [{
+            readonly label: "First";
+            readonly value: "first";
+        }, {
+            readonly label: "Second";
+            readonly value: "second's";
+        }];
+    }, {
+        readonly name: "json";
+        readonly type: "json";
+    }, {
+        readonly name: "localizedJson";
+        readonly type: "json";
+        readonly localized: true;
+    }, {
+        readonly name: "object";
+        readonly type: "object";
+    }, {
+        readonly name: "richText";
+        readonly type: "richText";
+    }, {
+        readonly name: "file";
+        readonly type: "file";
+    }, {
+        readonly name: "image";
+        readonly type: "image";
+    }, {
+        readonly name: "relation";
+        readonly type: "relation";
+        readonly targetCollection: "people";
+    }, {
+        readonly name: "relations";
+        readonly type: "relation";
+        readonly targetCollection: "people";
+        readonly hasMany: true;
+    }, {
+        readonly name: "optionalText";
+        readonly type: "text";
+        readonly optional: true;
+    }, {
+        readonly name: "group";
+        readonly type: "group";
+        readonly fields: readonly [{
+            readonly name: "title";
+            readonly type: "text";
+            readonly localized: true;
+        }, {
+            readonly name: "enabled";
+            readonly type: "boolean";
+            readonly optional: true;
+        }];
+    }, {
+        readonly name: "array";
+        readonly type: "array";
+        readonly fields: readonly [{
+            readonly name: "label";
+            readonly type: "text";
+            readonly localized: true;
+        }, {
+            readonly name: "score";
+            readonly type: "integer";
+            readonly optional: true;
+        }];
+    }, {
+        readonly name: "content's";
+        readonly type: "blocks";
+        readonly blocks: [{
+            readonly blockType: "quote'block";
+            readonly fields: readonly [{
+                readonly name: "quotation";
+                readonly type: "textArea";
+                readonly localized: true;
+            }, {
+                readonly name: "tone'choice";
+                readonly type: "select";
+                readonly optional: true;
+                readonly options: [{
+                    readonly label: "Calm";
+                    readonly value: "calm";
+                }, {
+                    readonly label: "Quoted";
+                    readonly value: "author's";
+                }];
+            }];
+        }, {
+            readonly blockType: "media";
+            readonly fields: readonly [{
+                readonly name: "caption";
+                readonly type: "text";
+                readonly localized: true;
+                readonly optional: true;
+            }, {
+                readonly name: "image";
+                readonly type: "image";
+            }];
+        }];
+    }];
+};
+export declare const MinimalCollection: {
+    readonly path: "minimal";
+    readonly labels: {
+        readonly singular: "Minimal";
+        readonly plural: "Minimal";
+    };
+    readonly fields: [{
+        readonly name: "title";
+        readonly type: "text";
+    }];
+};
+export declare const AllFieldsCollections: readonly [{
+    readonly path: "all-fields";
+    readonly labels: {
+        readonly singular: "All fields";
+        readonly plural: "All fields";
+    };
+    readonly fields: [{
+        readonly name: "integer";
+        readonly type: "integer";
+    }, {
+        readonly name: "float";
+        readonly type: "float";
+    }, {
+        readonly name: "counter";
+        readonly type: "counter";
+        readonly group: "fixture";
+    }, {
+        readonly name: "decimal";
+        readonly type: "decimal";
+    }, {
+        readonly name: "date";
+        readonly type: "date";
+    }, {
+        readonly name: "datetime";
+        readonly type: "datetime";
+    }, {
+        readonly name: "time";
+        readonly type: "time";
+    }, {
+        readonly name: "text";
+        readonly type: "text";
+    }, {
+        readonly name: "localizedText";
+        readonly type: "text";
+        readonly localized: true;
+    }, {
+        readonly name: "textArea";
+        readonly type: "textArea";
+    }, {
+        readonly name: "boolean";
+        readonly type: "boolean";
+    }, {
+        readonly name: "checkbox";
+        readonly type: "checkbox";
+    }, {
+        readonly name: "select";
+        readonly type: "select";
+        readonly options: [{
+            readonly label: "First";
+            readonly value: "first";
+        }, {
+            readonly label: "Second";
+            readonly value: "second's";
+        }];
+    }, {
+        readonly name: "json";
+        readonly type: "json";
+    }, {
+        readonly name: "localizedJson";
+        readonly type: "json";
+        readonly localized: true;
+    }, {
+        readonly name: "object";
+        readonly type: "object";
+    }, {
+        readonly name: "richText";
+        readonly type: "richText";
+    }, {
+        readonly name: "file";
+        readonly type: "file";
+    }, {
+        readonly name: "image";
+        readonly type: "image";
+    }, {
+        readonly name: "relation";
+        readonly type: "relation";
+        readonly targetCollection: "people";
+    }, {
+        readonly name: "relations";
+        readonly type: "relation";
+        readonly targetCollection: "people";
+        readonly hasMany: true;
+    }, {
+        readonly name: "optionalText";
+        readonly type: "text";
+        readonly optional: true;
+    }, {
+        readonly name: "group";
+        readonly type: "group";
+        readonly fields: readonly [{
+            readonly name: "title";
+            readonly type: "text";
+            readonly localized: true;
+        }, {
+            readonly name: "enabled";
+            readonly type: "boolean";
+            readonly optional: true;
+        }];
+    }, {
+        readonly name: "array";
+        readonly type: "array";
+        readonly fields: readonly [{
+            readonly name: "label";
+            readonly type: "text";
+            readonly localized: true;
+        }, {
+            readonly name: "score";
+            readonly type: "integer";
+            readonly optional: true;
+        }];
+    }, {
+        readonly name: "content's";
+        readonly type: "blocks";
+        readonly blocks: [{
+            readonly blockType: "quote'block";
+            readonly fields: readonly [{
+                readonly name: "quotation";
+                readonly type: "textArea";
+                readonly localized: true;
+            }, {
+                readonly name: "tone'choice";
+                readonly type: "select";
+                readonly optional: true;
+                readonly options: [{
+                    readonly label: "Calm";
+                    readonly value: "calm";
+                }, {
+                    readonly label: "Quoted";
+                    readonly value: "author's";
+                }];
+            }];
+        }, {
+            readonly blockType: "media";
+            readonly fields: readonly [{
+                readonly name: "caption";
+                readonly type: "text";
+                readonly localized: true;
+                readonly optional: true;
+            }, {
+                readonly name: "image";
+                readonly type: "image";
+            }];
+        }];
+    }];
+}, {
+    readonly path: "minimal";
+    readonly labels: {
+        readonly singular: "Minimal";
+        readonly plural: "Minimal";
+    };
+    readonly fields: [{
+        readonly name: "title";
+        readonly type: "text";
+    }];
+}];

package/dist/codegen/fixtures/all-fields.expected.d.ts

@@ -0,0 +1,120 @@
+import type { JsonObject, JsonValue, RelatedDocumentValue, StoredFileValue } from '@byline/core';
+export type MediaBlockData = {
+    _id: string;
+    _type: 'media';
+    caption?: string | undefined;
+    image: StoredFileValue;
+};
+export type MediaBlockDataAllLocales = {
+    _id: string;
+    _type: 'media';
+    caption?: {
+        [locale: string]: string;
+    } | undefined;
+    image: StoredFileValue;
+};
+export type QuoteBlockData = {
+    _id: string;
+    _type: "quote'block";
+    quotation: string;
+    "tone'choice"?: 'calm' | "author's" | undefined;
+};
+export type QuoteBlockDataAllLocales = {
+    _id: string;
+    _type: "quote'block";
+    quotation: {
+        [locale: string]: string;
+    };
+    "tone'choice"?: 'calm' | "author's" | undefined;
+};
+export type AllFieldsFields = {
+    integer: number;
+    float: number;
+    counter: number;
+    decimal: string;
+    date: Date;
+    datetime: Date;
+    time: string;
+    text: string;
+    localizedText: string;
+    textArea: string;
+    boolean: boolean;
+    checkbox: boolean;
+    select: 'first' | "second's";
+    json: JsonValue;
+    localizedJson: JsonValue;
+    object: JsonObject;
+    richText: JsonValue;
+    file: StoredFileValue;
+    image: StoredFileValue;
+    relation: RelatedDocumentValue;
+    relations: RelatedDocumentValue[];
+    optionalText?: string | undefined;
+    group: {
+        title: string;
+        enabled?: boolean | undefined;
+    };
+    array: Array<{
+        _id: string;
+        label: string;
+        score?: number | undefined;
+    }>;
+    "content's": Array<QuoteBlockData | MediaBlockData>;
+};
+export type AllFieldsFieldsAllLocales = {
+    integer: number;
+    float: number;
+    counter: number;
+    decimal: string;
+    date: Date;
+    datetime: Date;
+    time: string;
+    text: string;
+    localizedText: {
+        [locale: string]: string;
+    };
+    textArea: string;
+    boolean: boolean;
+    checkbox: boolean;
+    select: 'first' | "second's";
+    json: JsonValue;
+    localizedJson: {
+        [locale: string]: JsonValue;
+    };
+    object: JsonObject;
+    richText: JsonValue;
+    file: StoredFileValue;
+    image: StoredFileValue;
+    relation: RelatedDocumentValue;
+    relations: RelatedDocumentValue[];
+    optionalText?: string | undefined;
+    group: {
+        title: {
+            [locale: string]: string;
+        };
+        enabled?: boolean | undefined;
+    };
+    array: Array<{
+        _id: string;
+        label: {
+            [locale: string]: string;
+        };
+        score?: number | undefined;
+    }>;
+    "content's": Array<QuoteBlockDataAllLocales | MediaBlockDataAllLocales>;
+};
+export type MinimalFields = {
+    title: string;
+};
+export type MinimalFieldsAllLocales = {
+    title: string;
+};
+export type CollectionFieldsByPath = {
+    'all-fields': AllFieldsFields;
+    minimal: MinimalFields;
+};
+export type CollectionFieldsAllLocalesByPath = {
+    'all-fields': AllFieldsFieldsAllLocales;
+    minimal: MinimalFieldsAllLocales;
+};
+export type CollectionPath = keyof CollectionFieldsByPath;

package/dist/codegen/fixtures/all-fields.expected.js

@@ -0,0 +1 @@
+export {};

package/dist/codegen/fixtures/all-fields.js

@@ -0,0 +1,94 @@
+import { defineBlock, defineCollection } from '../../@types/collection-types.js';
+export const QuoteBlock = defineBlock({
+    blockType: "quote'block",
+    fields: [
+        { name: 'quotation', type: 'textArea', localized: true },
+        {
+            name: "tone'choice",
+            type: 'select',
+            optional: true,
+            options: [
+                { label: 'Calm', value: 'calm' },
+                { label: 'Quoted', value: "author's" },
+            ],
+        },
+    ],
+});
+export const MediaBlock = defineBlock({
+    blockType: 'media',
+    fields: [
+        { name: 'caption', type: 'text', localized: true, optional: true },
+        { name: 'image', type: 'image' },
+    ],
+});
+export const AllFieldsCollection = defineCollection({
+    path: 'all-fields',
+    labels: { singular: 'All fields', plural: 'All fields' },
+    fields: [
+        { name: 'integer', type: 'integer' },
+        { name: 'float', type: 'float' },
+        { name: 'counter', type: 'counter', group: 'fixture' },
+        { name: 'decimal', type: 'decimal' },
+        { name: 'date', type: 'date' },
+        { name: 'datetime', type: 'datetime' },
+        { name: 'time', type: 'time' },
+        { name: 'text', type: 'text' },
+        { name: 'localizedText', type: 'text', localized: true },
+        { name: 'textArea', type: 'textArea' },
+        { name: 'boolean', type: 'boolean' },
+        { name: 'checkbox', type: 'checkbox' },
+        {
+            name: 'select',
+            type: 'select',
+            options: [
+                { label: 'First', value: 'first' },
+                { label: 'Second', value: "second's" },
+            ],
+        },
+        { name: 'json', type: 'json' },
+        { name: 'localizedJson', type: 'json', localized: true },
+        { name: 'object', type: 'object' },
+        { name: 'richText', type: 'richText' },
+        { name: 'file', type: 'file' },
+        { name: 'image', type: 'image' },
+        { name: 'relation', type: 'relation', targetCollection: 'people' },
+        {
+            name: 'relations',
+            type: 'relation',
+            targetCollection: 'people',
+            hasMany: true,
+        },
+        {
+            name: 'optionalText',
+            type: 'text',
+            optional: true,
+        },
+        {
+            name: 'group',
+            type: 'group',
+            fields: [
+                { name: 'title', type: 'text', localized: true },
+                { name: 'enabled', type: 'boolean', optional: true },
+            ],
+        },
+        {
+            name: 'array',
+            type: 'array',
+            fields: [
+                { name: 'label', type: 'text', localized: true },
+                { name: 'score', type: 'integer', optional: true },
+            ],
+        },
+        {
+            name: "content's",
+            type: 'blocks',
+            blocks: [QuoteBlock, MediaBlock],
+        },
+    ],
+});
+export const MinimalCollection = defineCollection({
+    path: 'minimal',
+    labels: { singular: 'Minimal', plural: 'Minimal' },
+    fields: [{ name: 'title', type: 'text' }],
+});
+export const AllFieldsCollections = [AllFieldsCollection, MinimalCollection];

package/dist/codegen/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+import type { CollectionDefinition } from '../@types/index.js';
+/**
+ * Emit deterministic application collection types from evaluated runtime definitions.
+ * The returned hash is SHA-256 over the versioned format domain and generated module body.
+ */
+export declare function emitCollectionTypes(collections: readonly CollectionDefinition[]): {
+    source: string;
+    hash: string;
+};