@dereekb/model 9.0.0 → 9.1.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [9.1.0](https://github.com/dereekb/dbx-components/compare/v9.0.0-dev...v9.1.0) (2022-08-15)
+
+
+### Features
+
+* added WebsiteFileLink ([dc58b5c](https://github.com/dereekb/dbx-components/commit/dc58b5c3a78c1e6fbf3ee065b02b270f15f4dc79))
+
+
+
 # [9.0.0](https://github.com/dereekb/dbx-components/compare/v8.15.2-dev...v9.0.0) (2022-08-13)
 
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/model",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
-    "@dereekb/util": "9.0.0",
+    "@dereekb/util": "9.1.0",
     "lodash.isequal": "^4.5.0",
     "make-error": "^1.3.0",
     "ts-essentials": "^9.1.2",

package/src/lib/data/website/index.d.ts

@@ -1,2 +1,3 @@
 export * from './link';
+export * from './link.file';
 export * from './link.website';

package/src/lib/data/website/index.js

@@ -2,5 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./link"), exports);
+tslib_1.__exportStar(require("./link.file"), exports);
 tslib_1.__exportStar(require("./link.website"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/data/website/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/model/src/lib/data/website/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,yDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/model/src/lib/data/website/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,sDAA4B;AAC5B,yDAA+B"}

package/src/lib/data/website/link.d.ts

@@ -1,6 +1,15 @@
 import { ModelTypeString } from '@dereekb/util';
 export declare type WebsiteLinkType = ModelTypeString;
 export declare const UNKNOWN_WEBSITE_LINK_TYPE: WebsiteLinkType;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+export declare const WEBSITE_LINK_TYPE_MAX_LENGTH = 32;
+/**
+ * Alpha-numeric type between 1 and 32 characters only allowed.
+ */
+export declare const WEBSITE_LINK_TYPE_REGEX: RegExp;
+export declare function isValidWebsiteLinkType(input: string): input is WebsiteLinkType;
 export declare type WebsiteLinkEncodedData = string;
 export interface WebsiteLink {
     /**
@@ -12,3 +21,12 @@ export interface WebsiteLink {
      */
     d: WebsiteLinkEncodedData;
 }
+/**
+ * Default max length of WebsiteLink's data string.
+ */
+export declare const WEBSITE_LINK_ENCODED_DATA_MAX_LENGTH = 1000;
+export declare class WebsiteLink {
+    t: WebsiteLinkType;
+    d: WebsiteLinkEncodedData;
+    constructor(template: WebsiteLink);
+}

package/src/lib/data/website/link.file.d.ts

@@ -0,0 +1,78 @@
+import { ModelTypeString } from '@dereekb/util';
+import { WebsiteLink, WebsiteLinkEncodedData } from './link';
+/**
+ * Arbitrary file link type.
+ */
+export declare type WebsiteFileLinkType = ModelTypeString;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+export declare const WEBSITE_FILE_LINK_TYPE_MAX_LENGTH = 32;
+/**
+ * Has the same regex as WebsiteLinkType
+ */
+export declare const WEBSITE_FILE_LINK_TYPE_REGEX: RegExp;
+/**
+ * WebsiteFileLink's mime type.
+ */
+export declare type WebsiteFileLinkMimeType = string;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+export declare const WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH = 128;
+/**
+ * Default max length of WebsiteLink's data string.
+ */
+export declare const WEBSITE_FILE_LINK_MIME_TYPE_REGEX: RegExp;
+/**
+ * Arbitrary name. Has no pattern restriction, but must be 128 characters or less.
+ */
+export declare type WebsiteFileLinkName = string;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+export declare const WEBSITE_FILE_LINK_NAME_MAX_LENGTH = 128;
+/**
+ * WebsiteFileLink data. Typically a URL.
+ */
+export declare type WebsiteFileLinkData = string;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+export declare const WEBSITE_FILE_LINK_DATA_MAX_LENGTH: number;
+export declare const WEBSITE_FILE_LINK_DATA_REGEX: RegExp;
+/**
+ * A decoded WebsiteLink that points to a file somewhere.
+ */
+export interface WebsiteFileLink {
+    /**
+     * Arbitrary file type that can be used for identification.
+     */
+    type?: WebsiteFileLinkType;
+    /**
+     * File Type, if applicable
+     */
+    mime?: WebsiteFileLinkMimeType;
+    /**
+     * Display name, if applicable.
+     */
+    name?: WebsiteFileLinkName;
+    /**
+     * Arbitrary data.
+     */
+    data: WebsiteFileLinkData;
+}
+export declare type EncodedWebsiteFileLink = WebsiteLinkEncodedData;
+export declare class WebsiteFileLink {
+    type?: WebsiteFileLinkType;
+    mime?: WebsiteFileLinkType;
+    name?: WebsiteFileLinkName;
+    data: WebsiteFileLinkData;
+    constructor(template?: WebsiteFileLink);
+}
+export declare const WEBSITE_FILE_LINK_WEBSITE_LINK_TYPE = "f";
+export declare function websiteFileLinkToWebsiteLink(input: WebsiteFileLink): WebsiteLink;
+export declare function websiteLinkToWebsiteLinkFile(input: WebsiteLink): WebsiteFileLink;
+export declare const WEBSITE_FILE_LINK_ENCODE_SEPARATOR = "|";
+export declare function encodeWebsiteFileLinkToWebsiteLinkEncodedData(input: WebsiteFileLink): EncodedWebsiteFileLink;
+export declare function decodeWebsiteLinkEncodedDataToWebsiteFileLink(input: EncodedWebsiteFileLink): WebsiteFileLink;

package/src/lib/data/website/link.file.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeWebsiteLinkEncodedDataToWebsiteFileLink = exports.encodeWebsiteFileLinkToWebsiteLinkEncodedData = exports.WEBSITE_FILE_LINK_ENCODE_SEPARATOR = exports.websiteLinkToWebsiteLinkFile = exports.websiteFileLinkToWebsiteLink = exports.WEBSITE_FILE_LINK_WEBSITE_LINK_TYPE = exports.WebsiteFileLink = exports.WEBSITE_FILE_LINK_DATA_REGEX = exports.WEBSITE_FILE_LINK_DATA_MAX_LENGTH = exports.WEBSITE_FILE_LINK_NAME_MAX_LENGTH = exports.WEBSITE_FILE_LINK_MIME_TYPE_REGEX = exports.WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH = exports.WEBSITE_FILE_LINK_TYPE_REGEX = exports.WEBSITE_FILE_LINK_TYPE_MAX_LENGTH = void 0;
+const tslib_1 = require("tslib");
+const util_1 = require("@dereekb/util");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const link_1 = require("./link");
+/**
+ * Max length of WebsiteLink's data type.
+ */
+exports.WEBSITE_FILE_LINK_TYPE_MAX_LENGTH = link_1.WEBSITE_LINK_TYPE_MAX_LENGTH;
+/**
+ * Has the same regex as WebsiteLinkType
+ */
+exports.WEBSITE_FILE_LINK_TYPE_REGEX = link_1.WEBSITE_LINK_TYPE_REGEX;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+exports.WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH = 128;
+/**
+ * Default max length of WebsiteLink's data string.
+ */
+exports.WEBSITE_FILE_LINK_MIME_TYPE_REGEX = /^\w+\/[-+.\w]+$/;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+exports.WEBSITE_FILE_LINK_NAME_MAX_LENGTH = 128;
+/**
+ * Max length of WebsiteLink's data type.
+ */
+exports.WEBSITE_FILE_LINK_DATA_MAX_LENGTH = link_1.WEBSITE_LINK_ENCODED_DATA_MAX_LENGTH - 3 - exports.WEBSITE_FILE_LINK_TYPE_MAX_LENGTH - exports.WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH - exports.WEBSITE_FILE_LINK_NAME_MAX_LENGTH;
+exports.WEBSITE_FILE_LINK_DATA_REGEX = /^[^|]+$/;
+class WebsiteFileLink {
+    constructor(template) {
+        if (template) {
+            this.type = template.type;
+            this.mime = template.mime;
+            this.name = template.name;
+            this.data = template.data;
+        }
+    }
+}
+tslib_1.__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(exports.WEBSITE_FILE_LINK_TYPE_REGEX),
+    (0, class_validator_1.MaxLength)(link_1.WEBSITE_LINK_TYPE_MAX_LENGTH),
+    tslib_1.__metadata("design:type", String)
+], WebsiteFileLink.prototype, "type", void 0);
+tslib_1.__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(exports.WEBSITE_FILE_LINK_MIME_TYPE_REGEX),
+    (0, class_validator_1.MaxLength)(exports.WEBSITE_FILE_LINK_MIME_TYPE_MAX_LENGTH),
+    tslib_1.__metadata("design:type", String)
+], WebsiteFileLink.prototype, "mime", void 0);
+tslib_1.__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(exports.WEBSITE_FILE_LINK_NAME_MAX_LENGTH),
+    tslib_1.__metadata("design:type", String)
+], WebsiteFileLink.prototype, "name", void 0);
+tslib_1.__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.Matches)(exports.WEBSITE_FILE_LINK_DATA_REGEX),
+    (0, class_validator_1.MaxLength)(exports.WEBSITE_FILE_LINK_DATA_MAX_LENGTH),
+    tslib_1.__metadata("design:type", String)
+], WebsiteFileLink.prototype, "data", void 0);
+exports.WebsiteFileLink = WebsiteFileLink;
+exports.WEBSITE_FILE_LINK_WEBSITE_LINK_TYPE = 'f';
+function websiteFileLinkToWebsiteLink(input) {
+    return {
+        t: exports.WEBSITE_FILE_LINK_WEBSITE_LINK_TYPE,
+        d: encodeWebsiteFileLinkToWebsiteLinkEncodedData(input)
+    };
+}
+exports.websiteFileLinkToWebsiteLink = websiteFileLinkToWebsiteLink;
+function websiteLinkToWebsiteLinkFile(input) {
+    const encodedData = input.d;
+    return decodeWebsiteLinkEncodedDataToWebsiteFileLink(encodedData);
+}
+exports.websiteLinkToWebsiteLinkFile = websiteLinkToWebsiteLinkFile;
+exports.WEBSITE_FILE_LINK_ENCODE_SEPARATOR = '|';
+function encodeWebsiteFileLinkToWebsiteLinkEncodedData(input) {
+    const encoded = [input.type, input.mime, input.data, input.name].map((x) => x || '').join(exports.WEBSITE_FILE_LINK_ENCODE_SEPARATOR);
+    return encoded;
+}
+exports.encodeWebsiteFileLinkToWebsiteLinkEncodedData = encodeWebsiteFileLinkToWebsiteLinkEncodedData;
+function decodeWebsiteLinkEncodedDataToWebsiteFileLink(input) {
+    const [type, mime, data, name] = (0, util_1.splitJoinRemainder)(input, exports.WEBSITE_FILE_LINK_ENCODE_SEPARATOR, 4);
+    return (0, util_1.filterFalsyAndEmptyValues)({
+        type,
+        mime,
+        name,
+        data
+    });
+}
+exports.decodeWebsiteLinkEncodedDataToWebsiteFileLink = decodeWebsiteLinkEncodedDataToWebsiteFileLink;
+//# sourceMappingURL=link.file.js.map

package/src/lib/data/website/link.file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.file.js","sourceRoot":"","sources":["../../../../../../../packages/model/src/lib/data/website/link.file.ts"],"names":[],"mappings":";;;;AAAA,wCAA+F;AAC/F,yDAA2C;AAC3C,qDAAuF;AACvF,iCAA0J;AAO1J;;GAEG;AACU,QAAA,iCAAiC,GAAG,mCAA4B,CAAC;AAE9E;;GAEG;AACU,QAAA,4BAA4B,GAAG,8BAAuB,CAAC;AAOpE;;GAEG;AACU,QAAA,sCAAsC,GAAG,GAAG,CAAC;AAE1D;;GAEG;AACU,QAAA,iCAAiC,GAAG,iBAAiB,CAAC;AAOnE;;GAEG;AACU,QAAA,iCAAiC,GAAG,GAAG,CAAC;AAOrD;;GAEG;AACU,QAAA,iCAAiC,GAAG,2CAAoC,GAAG,CAAC,GAAG,yCAAiC,GAAG,8CAAsC,GAAG,yCAAiC,CAAC;AAE9L,QAAA,4BAA4B,GAAG,SAAS,CAAC;AA0BtD,MAAa,eAAe;IA2B1B,YAAY,QAA0B;QACpC,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;SAC3B;IACH,CAAC;CACF;AA7BC;IALC,IAAA,0BAAM,GAAE;IACR,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,yBAAO,EAAC,oCAA4B,CAAC;IACrC,IAAA,2BAAS,EAAC,mCAA4B,CAAC;;6CACb;AAO3B;IALC,IAAA,0BAAM,GAAE;IACR,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,yBAAO,EAAC,yCAAiC,CAAC;IAC1C,IAAA,2BAAS,EAAC,8CAAsC,CAAC;;6CACvB;AAM3B;IAJC,IAAA,0BAAM,GAAE;IACR,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,2BAAS,EAAC,yCAAiC,CAAC;;6CAClB;AAM3B;IAJC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,yBAAO,EAAC,oCAA4B,CAAC;IACrC,IAAA,2BAAS,EAAC,yCAAiC,CAAC;;6CAClB;AAzB7B,0CAmCC;AAEY,QAAA,mCAAmC,GAAG,GAAG,CAAC;AAEvD,SAAgB,4BAA4B,CAAC,KAAsB;IACjE,OAAO;QACL,CAAC,EAAE,2CAAmC;QACtC,CAAC,EAAE,6CAA6C,CAAC,KAAK,CAAC;KACxD,CAAC;AACJ,CAAC;AALD,oEAKC;AAED,SAAgB,4BAA4B,CAAC,KAAkB;IAC7D,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC;IAC5B,OAAO,6CAA6C,CAAC,WAAW,CAAC,CAAC;AACpE,CAAC;AAHD,oEAGC;AAEY,QAAA,kCAAkC,GAAG,GAAG,CAAC;AAEtD,SAAgB,6CAA6C,CAAC,KAAsB;IAClF,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,0CAAkC,CAAC,CAAC;IAC9H,OAAO,OAAO,CAAC;AACjB,CAAC;AAHD,sGAGC;AAED,SAAgB,6CAA6C,CAAC,KAA6B;IACzF,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,yBAAkB,EAAC,KAAK,EAAE,0CAAkC,EAAE,CAAC,CAAC,CAAC;IAElG,OAAO,IAAA,gCAAyB,EAAkB;QAChD,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AATD,sGASC"}

package/src/lib/data/website/link.js

@@ -1,5 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UNKNOWN_WEBSITE_LINK_TYPE = void 0;
+exports.WebsiteLink = exports.WEBSITE_LINK_ENCODED_DATA_MAX_LENGTH = exports.isValidWebsiteLinkType = exports.WEBSITE_LINK_TYPE_REGEX = exports.WEBSITE_LINK_TYPE_MAX_LENGTH = exports.UNKNOWN_WEBSITE_LINK_TYPE = void 0;
+const tslib_1 = require("tslib");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
 exports.UNKNOWN_WEBSITE_LINK_TYPE = 'u';
+/**
+ * Max length of WebsiteLink's data type.
+ */
+exports.WEBSITE_LINK_TYPE_MAX_LENGTH = 32;
+/**
+ * Alpha-numeric type between 1 and 32 characters only allowed.
+ */
+exports.WEBSITE_LINK_TYPE_REGEX = /^[a-zA-Z0-9]{1,32}$/;
+function isValidWebsiteLinkType(input) {
+    return exports.WEBSITE_LINK_TYPE_REGEX.test(input);
+}
+exports.isValidWebsiteLinkType = isValidWebsiteLinkType;
+/**
+ * Default max length of WebsiteLink's data string.
+ */
+exports.WEBSITE_LINK_ENCODED_DATA_MAX_LENGTH = 1000;
+class WebsiteLink {
+    constructor(template) {
+        if (template) {
+            this.t = template.t;
+            this.d = template.d;
+        }
+    }
+}
+tslib_1.__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.Matches)(exports.WEBSITE_LINK_TYPE_REGEX),
+    (0, class_validator_1.MaxLength)(exports.WEBSITE_LINK_TYPE_MAX_LENGTH),
+    tslib_1.__metadata("design:type", String)
+], WebsiteLink.prototype, "t", void 0);
+tslib_1.__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.MaxLength)(exports.WEBSITE_LINK_ENCODED_DATA_MAX_LENGTH),
+    tslib_1.__metadata("design:type", String)
+], WebsiteLink.prototype, "d", void 0);
+exports.WebsiteLink = WebsiteLink;
 //# sourceMappingURL=link.js.map

package/src/lib/data/website/link.js.map

@@ -1 +1 @@
-{"version":3,"file":"link.js","sourceRoot":"","sources":["../../../../../../../packages/model/src/lib/data/website/link.ts"],"names":[],"mappings":";;;AAIa,QAAA,yBAAyB,GAAoB,GAAG,CAAC"}
+{"version":3,"file":"link.js","sourceRoot":"","sources":["../../../../../../../packages/model/src/lib/data/website/link.ts"],"names":[],"mappings":";;;;AACA,yDAA2C;AAC3C,qDAA2E;AAI9D,QAAA,yBAAyB,GAAoB,GAAG,CAAC;AAE9D;;GAEG;AACU,QAAA,4BAA4B,GAAG,EAAE,CAAC;AAE/C;;GAEG;AACU,QAAA,uBAAuB,GAAG,qBAAqB,CAAC;AAE7D,SAAgB,sBAAsB,CAAC,KAAa;IAClD,OAAO,+BAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC;AAFD,wDAEC;AAeD;;GAEG;AACU,QAAA,oCAAoC,GAAG,IAAI,CAAC;AAEzD,MAAa,WAAW;IActB,YAAY,QAAqB;QAC/B,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;YACpB,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;SACrB;IACH,CAAC;CACF;AAdC;IALC,IAAA,0BAAM,GAAE;IACR,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,yBAAO,EAAC,+BAAuB,CAAC;IAChC,IAAA,2BAAS,EAAC,oCAA4B,CAAC;;sCACpB;AAMpB;IAJC,IAAA,0BAAM,GAAE;IACR,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,2BAAS,EAAC,4CAAoC,CAAC;;sCACrB;AAZ7B,kCAoBC"}