@nascentdigital/funnel-core 4.6.7 → 5.0.1

package/dist/schema/Block.d.ts

@@ -81,6 +81,7 @@ export declare namespace Block {
         } & {
             [key in keyof T]: Field.Data<Optional.InnerType<T[key]>>;
         };
+        function filter(value: any): value is Data;
     }
     type LinkedData<T extends Block = Block> = Omit<Data<T>, 'fields'> & {
         fields: LinkedData.ForFields<T['fields']>;

package/dist/schema/Block.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Block = void 0;
 const errors_1 = require("../errors");
+const utils_1 = require("../utils");
 const Fields_1 = require("./Fields");
 const Optional_1 = require("./Optional");
 // class
@@ -132,4 +133,16 @@ exports.Block = Block;
         }
         Property.normalize = normalize;
     })(Property = Block.Property || (Block.Property = {}));
+    let Data;
+    (function (Data) {
+        // helpers
+        function filter(value) {
+            return !!value
+                && utils_1.Value.typeOf(value) === 'object'
+                && value.type === 'block'
+                && typeof value.id === 'string'
+                && typeof value.version === 'number';
+        }
+        Data.filter = filter;
+    })(Data = Block.Data || (Block.Data = {}));
 })(Block || (exports.Block = Block = {}));

package/dist/schema/Fields.d.ts

@@ -1,6 +1,6 @@
 import { StringKeyOf } from 'type-fest';
 import { Transform } from '../types';
-import { AssetField, EnumField, Field, ListField, RichTextField, TextField } from './field';
+import { AssetField, CollectionField, EnumField, Field, ListField, RichTextField, TextField } from './field';
 import { Optional } from './Optional';
 export type Fields = Record<string, Optional.Maybe<Field.Type>>;
 export declare namespace Fields {
@@ -38,6 +38,12 @@ export declare namespace Fields {
     namespace ListFields {
         type Keys<TFields extends Fields> = StringKeyOf<ListFields<TFields>>;
     }
+    type CollectionFields<TFields extends Fields> = {
+        [key in keyof TFields as TFields[key] extends CollectionField ? key : TFields[key] extends _Optional<CollectionField> ? key : never]: TFields[key];
+    };
+    namespace CollectionFields {
+        type Keys<TFields extends Fields> = StringKeyOf<CollectionFields<TFields>>;
+    }
     function unwrap<TFields extends Fields>(fields: TFields): UnwrapOptional<TFields>;
 }
 type _Optional<T extends Optional.Content> = Optional<T>;

package/dist/schema/field/base/AssetField.js

@@ -112,7 +112,7 @@ exports.AssetField = AssetField;
     })(Tags = AssetField.Tags || (AssetField.Tags = {}));
     let Value;
     (function (Value) {
-        // guard
+        // guards
         function filter(value) {
             return !!value
                 && typeof value === 'object'

package/dist/schema/field/base/EmbeddedVideoField.d.ts

@@ -1,8 +1,8 @@
+import { Size } from '../../../ui';
 import { Field } from '../index';
 export declare class EmbeddedVideoField extends Field<EmbeddedVideoField> {
     readonly type: "embedded.video";
-    readonly allowMuting: boolean;
-    constructor({ allowMuting, ...args }: EmbeddedVideoField.ConstructorArgs);
+    constructor(args: EmbeddedVideoField.ConstructorArgs);
     modify(args: EmbeddedVideoField.ModifyArgs): EmbeddedVideoField;
 }
 export declare namespace EmbeddedVideoField {
@@ -16,8 +16,8 @@ export declare namespace EmbeddedVideoField {
         type Youtube = {
             type: 'youtube';
             videoId: string;
+            dimensions: Size;
             thumbUrl: string;
-            muted?: boolean;
         };
         namespace Youtube {
             function filter(data: Value): data is Youtube;
@@ -25,9 +25,9 @@ export declare namespace EmbeddedVideoField {
         type Vimeo = {
             type: 'vimeo';
             videoId: string;
+            dimensions: Size;
             thumbUrl: string;
             hash?: string;
-            muted?: boolean;
         };
         namespace Vimeo {
             function filter(data: Value): data is Vimeo;
@@ -38,8 +38,6 @@ export declare namespace EmbeddedVideoField {
         function fromUrl(url?: URL): Value | undefined;
         function toUrl(value: Value, type?: 'watch' | 'embed'): URL;
     }
-    type ConstructorArgs = Field.ConstructorArgs & {
-        allowMuting?: boolean;
-    };
+    type ConstructorArgs = Field.ConstructorArgs;
     type ModifyArgs = Omit<Partial<ConstructorArgs>, 'required'>;
 }

package/dist/schema/field/base/EmbeddedVideoField.js

@@ -1,30 +1,16 @@
 "use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmbeddedVideoField = void 0;
 const index_1 = require("../index");
 // class
 class EmbeddedVideoField extends index_1.Field {
-    constructor(_a) {
-        var { allowMuting = true } = _a, args = __rest(_a, ["allowMuting"]);
+    constructor(args) {
         // construct base
         super(args);
         this.type = 'embedded.video';
-        // initialize instance variables
-        this.allowMuting = allowMuting;
     }
     modify(args) {
-        return new EmbeddedVideoField(Object.assign({ name: this.name, hint: this.hint, description: this.description, required: this.required, allowMuting: this.allowMuting }, args));
+        return new EmbeddedVideoField(Object.assign({ name: this.name, hint: this.hint, description: this.description, required: this.required }, args));
     }
 }
 exports.EmbeddedVideoField = EmbeddedVideoField;
@@ -102,7 +88,8 @@ exports.EmbeddedVideoField = EmbeddedVideoField;
                         return {
                             type: 'youtube',
                             videoId: pathComponents[1],
-                            thumbUrl: ''
+                            thumbUrl: '',
+                            dimensions: { width: 0, height: 0 }
                         };
                     }
                     else if (action === 'watch') {
@@ -112,7 +99,8 @@ exports.EmbeddedVideoField = EmbeddedVideoField;
                                 {
                                     type: 'youtube',
                                     videoId,
-                                    thumbUrl: ''
+                                    thumbUrl: '',
+                                    dimensions: { width: 0, height: 0 }
                                 }
                             : undefined;
                     }
@@ -130,6 +118,7 @@ exports.EmbeddedVideoField = EmbeddedVideoField;
                             {
                                 type: 'vimeo',
                                 videoId,
+                                dimensions: { width: 0, height: 0 },
                                 thumbUrl: '',
                                 hash
                             }
@@ -142,6 +131,7 @@ exports.EmbeddedVideoField = EmbeddedVideoField;
                         return {
                             type: 'vimeo',
                             videoId: pathComponents[1],
+                            dimensions: { width: 0, height: 0 },
                             thumbUrl: '',
                             hash
                         };

package/dist/schema/field/composite/ObjectField.d.ts

@@ -1,11 +1,11 @@
-import { Optional } from '../../Optional';
-import { Field, ListField, AssetField } from '../index';
+import type { Optional } from '../../Optional';
+import { AssetField, Field, ListField } from '../index';
 export declare class ObjectField<TContent extends ObjectField.Content = ObjectField.Content> extends Field<ObjectField<TContent>> {
     readonly type: "object";
     readonly content: TContent;
     readonly preview: Readonly<ObjectField.Preview<TContent>>;
     constructor(args: ObjectField.ConstructorArgs<TContent>);
-    modify(args: ObjectField.ModifyArgs): ObjectField<TContent>;
+    modify(args: ObjectField.ModifyArgs<TContent>): ObjectField<TContent>;
 }
 export declare namespace ObjectField {
     type _Optional<T extends Optional.Content> = Optional<T>;
@@ -46,7 +46,7 @@ export declare namespace ObjectField {
         preview: Preview<TContent>;
         content: TContent;
     };
-    export type ModifyArgs = Partial<Field.ConstructorArgs>;
+    export type ModifyArgs<TContent extends Content> = Partial<ConstructorArgs<TContent>>;
     export type Preview<TContent extends Content = Content> = {
         title: keyof Content.Required<Content.Text<TContent>>;
         subtitle?: keyof Content.Text<TContent>;

package/dist/ui/fields/ObjectField.d.ts

@@ -1,16 +1,18 @@
 import { Observable } from 'rxjs';
+import { StringKeyOf } from 'type-fest';
 import * as Schema from '../../schema';
 import { EventBus } from '../../services';
 import { Field } from './Field';
 import { FieldList } from './FieldList';
 import { FieldModel } from './FieldModel';
 import { FieldValidator } from './FieldValidator';
-export declare class ObjectField {
-    readonly schema: Schema.ObjectField;
+import { SchemaToField } from './SchemaToField';
+export declare class ObjectField<TObject extends Schema.ObjectField = Schema.ObjectField> {
+    readonly schema: TObject;
     readonly id: string;
     readonly name: string;
     readonly required: boolean;
-    readonly publishedValue: ObjectField.Value | undefined;
+    readonly publishedValue: ObjectField.Value<TObject> | undefined;
     private readonly eventBus;
     private readonly _content;
     private readonly _fields;
@@ -21,7 +23,7 @@ export declare class ObjectField {
     private _optOut?;
     constructor(args: ObjectField.ConstructorArgs);
     get events$(): Observable<FieldModel.Event>;
-    get initialValue(): ObjectField.Value | undefined;
+    get initialValue(): ObjectField.Value<TObject> | undefined;
     get exists(): boolean;
     get isNew(): boolean;
     get valid(): boolean;
@@ -29,9 +31,10 @@ export declare class ObjectField {
     get errors(): FieldValidator.Error[];
     get content(): Readonly<ObjectField.Fields>;
     get fields(): readonly ObjectField.FieldsValues[];
+    getField<TFields extends ObjectField.GetField.Fields<TObject>, TFieldId extends StringKeyOf<TFields>>(fieldId: TFieldId): SchemaToField<TFields[TFieldId]>;
     get hasValue(): boolean;
-    get value(): ObjectField.Value;
-    set value(value: ObjectField.Value);
+    get value(): ObjectField.Value<TObject>;
+    set value(value: ObjectField.Value<TObject>);
     get modified(): boolean;
     get changed(): boolean;
     get preview(): ObjectField.Preview;
@@ -44,12 +47,24 @@ export declare class ObjectField {
     getString(key: string | undefined): string | undefined;
     onSaveStart(): void;
     onSaveComplete(): void;
-    reset(initialValue?: ObjectField.Value | null): void;
+    reset(initialValue?: ObjectField.Value<TObject> | null): void;
     clone(): ObjectField;
     private raiseEvent;
     static forSchema(schema: Schema.ObjectField): ObjectField;
 }
 export declare namespace ObjectField {
+    type Fields = Record<string, FieldsValues>;
+    type FieldsValues = Field | FieldList | ObjectField;
+    type Value<TObject extends Schema.ObjectField = Schema.ObjectField> = Schema.Field.Data<TObject>;
+    type Data<TObject extends Schema.ObjectField = Schema.ObjectField> = Value<TObject>['value'];
+    type Preview = {
+        title: Field<Schema.TextField | Schema.RichTextField>;
+        subtitle?: Field<Schema.TextField | Schema.RichTextField>;
+        visual?: Field<Schema.AssetField>;
+    };
+    namespace GetField {
+        type Fields<TObject extends Schema.ObjectField> = Schema.Fields.UnwrapOptional<TObject['content']>;
+    }
     type ConstructorArgs = {
         eventBus: EventBus;
         schema: Schema.ObjectField;
@@ -59,15 +74,6 @@ export declare namespace ObjectField {
         initialValue?: Value;
         required: boolean;
     };
-    type Value = Schema.Field.Data<Schema.ObjectField>;
-    type Fields = Record<string, FieldsValues>;
-    type FieldsValues = Field | FieldList | ObjectField;
-    type Data = Record<string, Schema.Field.Data<Schema.ObjectField.Content.Type>>;
-    type Preview = {
-        title: Field<Schema.TextField | Schema.RichTextField>;
-        subtitle?: Field<Schema.TextField | Schema.RichTextField>;
-        visual?: Field<Schema.AssetField>;
-    };
     interface Event extends EventBus.Event<'ObjectField', Event.Type> {
         field: ObjectField;
     }

package/dist/ui/fields/ObjectField.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObjectField = void 0;
 const rxjs_1 = require("rxjs");
+const errors_1 = require("../../errors");
 const services_1 = require("../../services");
 const utils_1 = require("../../utils");
 const Field_1 = require("./Field");
@@ -61,6 +62,15 @@ class ObjectField {
     get fields() {
         return this._fields;
     }
+    getField(fieldId) {
+        // find field (or throw)
+        const field = this._fields.find(field => field.id === fieldId);
+        if (!field) {
+            throw new errors_1.IllegalStateError(`${this.schema.type} object doesn't seem to have the ${fieldId} field`);
+        }
+        // return field
+        return field;
+    }
     get hasValue() {
         return this._fields.some(field => field.hasValue);
     }
@@ -68,8 +78,9 @@ class ObjectField {
         // reduce value from fields
         return {
             type: 'object',
-            value: this._fields.reduce((values, { id, value }) => {
+            value: this._fields.reduce((valuesRaw, { id, value }) => {
                 // bind value if it's set
+                const values = valuesRaw;
                 if (value !== undefined) {
                     values[id] = value;
                 }
@@ -279,9 +290,15 @@ function deserializeFields({ eventBus, schema, initialValue }) {
             case 'richtext':
             case 'enum':
             case 'boolean':
+            case 'timestamp':
+            case 'date':
             case 'link':
             case 'asset':
+            case 'embedded.video':
+            case 'page':
+            case 'dynamic.pages':
             case 'collection':
+            case 'form':
                 fields[id] = new Field_1.Field({
                     eventBus,
                     schema: fieldSchema,

package/dist/ui/fields/SchemaToField.d.ts

@@ -0,0 +1,7 @@
+import * as Schema from '../../schema';
+import { Field } from './Field';
+import { ObjectField } from './ObjectField';
+export type SchemaToField<T extends Schema.Field.Type> = T extends Schema.TextField ? Field<Schema.TextField> : T extends Schema.RichTextField ? Field<Schema.RichTextField> : T extends Schema.EnumField ? Field<Schema.EnumField> : T extends Schema.BooleanField ? Field<Schema.BooleanField> : T extends Schema.DateField ? Field<Schema.DateField> : T extends Schema.TimestampField ? Field<Schema.TimestampField> : T extends Schema.LinkField ? Field<Schema.LinkField> : T extends Schema.EmbeddedVideoField ? Field<Schema.EmbeddedVideoField> : T extends Schema.AssetField<infer F> ? Field<Schema.AssetField<F>> : T extends Schema.CollectionField ? Field<Schema.CollectionField> : T extends Schema.PageField ? Field<Schema.PageField> : T extends Schema.ObjectField<infer O> ? ObjectField<T> : T extends Schema.DynamicPagesField ? Field<Schema.DynamicPagesField> : never;
+export type SchemaToFields<TFields extends Record<string, Schema.Optional.Maybe<Schema.Field.Type>>> = {
+    [TKey in keyof TFields]: SchemaToField<Schema.Optional.InnerType<TFields[TKey]>>;
+};

package/dist/ui/fields/SchemaToField.js

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

package/dist/ui/fields/index.d.ts

@@ -5,4 +5,5 @@ export * from './FieldModel';
 export * from './FieldSerializer';
 export * from './FieldValidator';
 export * from './ObjectField';
+export * from './SchemaToField';
 export * from './validators/ValidatorHelper';

package/dist/ui/fields/index.js

@@ -21,4 +21,5 @@ __exportStar(require("./FieldModel"), exports);
 __exportStar(require("./FieldSerializer"), exports);
 __exportStar(require("./FieldValidator"), exports);
 __exportStar(require("./ObjectField"), exports);
+__exportStar(require("./SchemaToField"), exports);
 __exportStar(require("./validators/ValidatorHelper"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-core",
-  "version": "4.6.7",
+  "version": "5.0.1",
   "repository": {
     "url": "git+https://github.com/nascentdigital/funnel.git",
     "directory": "libs/core"
@@ -65,5 +65,5 @@
     "jest-tsd": "^0.2.2",
     "ts-jest": "^29.3.2"
   },
-  "gitHead": "b17e33b4400391b3984e61225c572f097c4c26c9"
+  "gitHead": "6ac66e04e5d6d10b959826b84cf3827422ddf47b"
 }