@kravc/schema 2.7.6 → 2.8.0-alpha.0

package/dist/helpers/validateId.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validator_1 = require("validator");
+/**
+ * Validates that a value is a URL or a DID (Decentralized Identifier).
+ * Throws if the value is missing, null, undefined, or not a valid URL/DID.
+ *
+ * **Intent**
+ * Enforce that identifier-style parameters (schema IDs, credential IDs, subject
+ * references, etc.) are either resolvable URLs or W3C DIDs before they are used
+ * in Linked Data or verification flows. This prevents malformed or arbitrary
+ * strings from propagating into storage, APIs, or cryptographic operations.
+ *
+ * **Use cases**
+ * - Validating `schemaId`, `credentialId`, or similar parameters in credential
+ *   and schema factories before creating or resolving documents.
+ * - Input validation for APIs that accept URI identifiers (e.g. fetch by ID).
+ * - Guarding helpers that resolve or dereference IDs (e.g. document loaders,
+ *   schema registries) from invalid input.
+ *
+ * **Examples**
+ *
+ * Valid — URLs:
+ *   validateId('schemaId', 'https://example.com/schemas/v1');
+ *   validateId('id', 'http://example.com:8080/path?q=1');
+ *
+ * Valid — DIDs (case-insensitive `did:` prefix):
+ *   validateId('subject', 'did:example:123456789');
+ *   validateId('subject', 'did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK');
+ *
+ * Throws — missing or invalid:
+ *   validateId('id', '');        // Error: Parameter "id" is required
+ *   validateId('id', null);      // Error: Parameter "id" is required
+ *   validateId('id', 'not-a-uri'); // Error: Parameter "id" must be a URL, received: "not-a-uri"
+ *
+ * @param name - Parameter name used in error messages (e.g. `"schemaId"`, `"credentialId"`).
+ * @param value - The value to validate (`string`, `null`, or `undefined`).
+ * @throws {Error} When `value` is falsy, or when it is not a URL and does not start with `did:`.
+ */
+const validateId = (name, value) => {
+    if (!value) {
+        throw new Error(`Parameter "${name}" is required`);
+    }
+    const isURI = value.toLowerCase().startsWith('did:') || (0, validator_1.isURL)(value);
+    if (isURI) {
+        return;
+    }
+    throw new Error(`Parameter "${name}" must be a URL, received: "${value}"`);
+};
+exports.default = validateId;
+//# sourceMappingURL=validateId.js.map

package/dist/helpers/validateId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateId.js","sourceRoot":"","sources":["../../src/helpers/validateId.ts"],"names":[],"mappings":";;AAAA,yCAAkC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,KAAgC,EAAE,EAAE;IACpE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,eAAe,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,IAAA,iBAAK,EAAC,KAAK,CAAC,CAAC;IAErE,IAAI,KAAK,EAAE,CAAC;QACV,OAAO;IACT,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,+BAA+B,KAAK,GAAG,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF,kBAAe,UAAU,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import Schema from './Schema';
+import Validator from './Validator';
+import documentLoader from './ld/documentLoader';
+import ValidationError from './ValidationError';
+import CredentialFactory from './CredentialFactory';
+export { Schema, Validator, documentLoader, ValidationError, CredentialFactory };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EACL,MAAM,EACN,SAAS,EACT,cAAc,EACd,eAAe,EACf,iBAAiB,EAClB,CAAC"}

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CredentialFactory = exports.ValidationError = exports.documentLoader = exports.Validator = exports.Schema = void 0;
+const Schema_1 = __importDefault(require("./Schema"));
+exports.Schema = Schema_1.default;
+const Validator_1 = __importDefault(require("./Validator"));
+exports.Validator = Validator_1.default;
+const documentLoader_1 = __importDefault(require("./ld/documentLoader"));
+exports.documentLoader = documentLoader_1.default;
+const ValidationError_1 = __importDefault(require("./ValidationError"));
+exports.ValidationError = ValidationError_1.default;
+const CredentialFactory_1 = __importDefault(require("./CredentialFactory"));
+exports.CredentialFactory = CredentialFactory_1.default;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAO5B,iBAPK,gBAAM,CAOL;AANR,4DAAoC;AAOlC,oBAPK,mBAAS,CAOL;AANX,yEAAiD;AAO/C,yBAPK,wBAAc,CAOL;AANhB,wEAAgD;AAO9C,0BAPK,yBAAe,CAOL;AANjB,4EAAoD;AAOlD,4BAPK,2BAAiB,CAOL"}

package/dist/ld/documentLoader.d.ts

@@ -0,0 +1,8 @@
+/** Returns document from the context via url */
+declare const documentLoader: (documentUrl: string) => {
+    document: Record<string, unknown>;
+    contextUrl: null;
+    documentUrl: string;
+};
+export default documentLoader;
+//# sourceMappingURL=documentLoader.d.ts.map

package/dist/ld/documentLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentLoader.d.ts","sourceRoot":"","sources":["../../src/ld/documentLoader.ts"],"names":[],"mappings":"AAQA,gDAAgD;AAChD,QAAA,MAAM,cAAc,GAAI,aAAa,MAAM;;;;CAgB1C,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/ld/documentLoader.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const security_context_1 = require("security-context");
+const credentials_context_1 = require("credentials-context");
+const CONTEXTS = new Map([
+    ...security_context_1.contexts,
+    ...credentials_context_1.contexts
+]);
+/** Returns document from the context via url */
+const documentLoader = (documentUrl) => {
+    const contextUrl = null;
+    const [url] = documentUrl.split('#');
+    const document = CONTEXTS.get(url);
+    if (!document) {
+        throw new Error(`Custom context "${documentUrl}" is not supported`);
+    }
+    return {
+        document,
+        contextUrl,
+        documentUrl
+    };
+};
+exports.default = documentLoader;
+//# sourceMappingURL=documentLoader.js.map

package/dist/ld/documentLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentLoader.js","sourceRoot":"","sources":["../../src/ld/documentLoader.ts"],"names":[],"mappings":";;AAAA,uDAAmE;AACnE,6DAAyE;AAEzE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC;IACvB,GAAG,2BAAmB;IACtB,GAAG,8BAAsB;CAC1B,CAAC,CAAC;AAEH,gDAAgD;AAChD,MAAM,cAAc,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC7C,MAAM,UAAU,GAAG,IAAI,CAAC;IAExB,MAAM,CAAE,GAAG,CAAE,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAEnC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,oBAAoB,CAAC,CAAC;IACtE,CAAC;IAED,OAAO;QACL,QAAQ;QACR,UAAU;QACV,WAAW;KACZ,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,cAAc,CAAC"}

package/dist/ld/getLinkedDataAttributeType.d.ts

@@ -0,0 +1,10 @@
+export type PropertySchema = {
+    '@type'?: string;
+    $ref?: string;
+    type?: string;
+    format?: string;
+};
+/** Returns linked data attribute type for a property schema, unless @type is defined */
+declare const getLinkedDataAttributeType: (propertySchema: PropertySchema) => string | undefined;
+export default getLinkedDataAttributeType;
+//# sourceMappingURL=getLinkedDataAttributeType.d.ts.map

package/dist/ld/getLinkedDataAttributeType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLinkedDataAttributeType.d.ts","sourceRoot":"","sources":["../../src/ld/getLinkedDataAttributeType.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wFAAwF;AACxF,QAAA,MAAM,0BAA0B,GAAI,gBAAgB,cAAc,KAAG,MAAM,GAAG,SAiC7E,CAAC;AAEF,eAAe,0BAA0B,CAAC"}

package/dist/ld/getLinkedDataAttributeType.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+/** Returns linked data attribute type for a property schema, unless @type is defined */
+const getLinkedDataAttributeType = (propertySchema) => {
+    const isOverriden = !!(0, lodash_1.get)(propertySchema, '@type');
+    if (isOverriden) {
+        return (0, lodash_1.get)(propertySchema, '@type');
+    }
+    // TODO: Add support for all types and formats, extend schema library with
+    //       support for additional formats, e.g. URL, Duration etc.
+    const { type, format } = propertySchema;
+    const isDate = format === 'date';
+    const isNumber = type === 'number';
+    const isInteger = type === 'integer';
+    const isDateTime = format === 'date-time';
+    if (isInteger) {
+        return 'schema:Integer';
+    }
+    if (isNumber) {
+        return 'schema:Number';
+    }
+    if (isDate) {
+        return 'schema:Date';
+    }
+    if (isDateTime) {
+        return 'schema:DateTime';
+    }
+    return;
+};
+exports.default = getLinkedDataAttributeType;
+//# sourceMappingURL=getLinkedDataAttributeType.js.map

package/dist/ld/getLinkedDataAttributeType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLinkedDataAttributeType.js","sourceRoot":"","sources":["../../src/ld/getLinkedDataAttributeType.ts"],"names":[],"mappings":";;AAAA,mCAA6B;AAS7B,wFAAwF;AACxF,MAAM,0BAA0B,GAAG,CAAC,cAA8B,EAAsB,EAAE;IACxF,MAAM,WAAW,GAAG,CAAC,CAAC,IAAA,YAAG,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAEnD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,IAAA,YAAG,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,0EAA0E;IAC1E,gEAAgE;IAChE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;IAExC,MAAM,MAAM,GAAG,MAAM,KAAK,MAAM,CAAC;IACjC,MAAM,QAAQ,GAAG,IAAI,KAAK,QAAQ,CAAC;IACnC,MAAM,SAAS,GAAG,IAAI,KAAK,SAAS,CAAC;IACrC,MAAM,UAAU,GAAG,MAAM,KAAK,WAAW,CAAC;IAE1C,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,OAAO;AACT,CAAC,CAAC;AAEF,kBAAe,0BAA0B,CAAC"}

package/dist/ld/getLinkedDataContext.d.ts

@@ -0,0 +1,19 @@
+import { type PropertySchema } from './getLinkedDataAttributeType';
+export type { PropertySchema };
+type ContextProperty = {
+    '@id': string;
+    '@type'?: string;
+};
+type ContextHeader = {
+    '@vocab': string;
+    '@version': number;
+    '@protected': boolean;
+    schema?: string;
+};
+export type LinkedDataContext = ContextHeader & {
+    [key: string]: ContextProperty | string | number | boolean | undefined;
+};
+/** Returns linked data context for a properties object */
+declare const getLinkedDataContext: (properties: Record<string, PropertySchema>, vocabUri: string) => LinkedDataContext;
+export default getLinkedDataContext;
+//# sourceMappingURL=getLinkedDataContext.d.ts.map

package/dist/ld/getLinkedDataContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLinkedDataContext.d.ts","sourceRoot":"","sources":["../../src/ld/getLinkedDataContext.ts"],"names":[],"mappings":"AAAA,OAAmC,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE/F,YAAY,EAAE,cAAc,EAAE,CAAC;AAU/B,KAAK,eAAe,GAAG;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG;IAC9C,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CACxE,CAAC;AAEF,0DAA0D;AAC1D,QAAA,MAAM,oBAAoB,GAAI,YAAY,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,UAAU,MAAM,KAAG,iBAgD5F,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/ld/getLinkedDataContext.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getLinkedDataAttributeType_1 = __importDefault(require("./getLinkedDataAttributeType"));
+const SCHEMA_ORG_URI = 'https://schema.org/';
+const PROTECTED_PROPERTIES = [
+    'id',
+    'type',
+    'schema'
+];
+/** Returns linked data context for a properties object */
+const getLinkedDataContext = (properties, vocabUri) => {
+    const context = {};
+    // TODO: Add support for embedded object, array and enum.
+    for (const key in properties) {
+        const propertySchema = properties[key];
+        const isProtected = PROTECTED_PROPERTIES.includes(key) ||
+            key.startsWith('@');
+        if (isProtected) {
+            continue;
+        }
+        context[key] = { '@id': key };
+        const { $ref } = propertySchema;
+        if ($ref) {
+            continue;
+        }
+        const linkedDataType = (0, getLinkedDataAttributeType_1.default)(propertySchema);
+        if (linkedDataType) {
+            context[key]['@type'] = linkedDataType;
+        }
+    }
+    const vocab = vocabUri.endsWith('/') || vocabUri.endsWith('#') ? vocabUri : `${vocabUri}#`;
+    const contextHeader = {
+        '@vocab': vocab,
+        '@version': 1.1,
+        '@protected': true
+    };
+    const isSchemaOrgDomain = vocab === SCHEMA_ORG_URI;
+    if (!isSchemaOrgDomain) {
+        contextHeader.schema = SCHEMA_ORG_URI;
+    }
+    return {
+        ...contextHeader,
+        ...context
+    };
+};
+exports.default = getLinkedDataContext;
+//# sourceMappingURL=getLinkedDataContext.js.map

package/dist/ld/getLinkedDataContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLinkedDataContext.js","sourceRoot":"","sources":["../../src/ld/getLinkedDataContext.ts"],"names":[],"mappings":";;;;;AAAA,8FAA+F;AAI/F,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAE7C,MAAM,oBAAoB,GAAG;IAC3B,IAAI;IACJ,MAAM;IACN,QAAQ;CACT,CAAC;AAkBF,0DAA0D;AAC1D,MAAM,oBAAoB,GAAG,CAAC,UAA0C,EAAE,QAAgB,EAAqB,EAAE;IAC/G,MAAM,OAAO,GAAG,EAAqC,CAAC;IAEtD,yDAAyD;IACzD,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC7B,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAEvC,MAAM,WAAW,GACf,oBAAoB,CAAC,QAAQ,CAAC,GAAG,CAAC;YAClC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAEtB,IAAI,WAAW,EAAE,CAAC;YAChB,SAAS;QACX,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;QAE9B,MAAM,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC;QAEhC,IAAI,IAAI,EAAE,CAAC;YACT,SAAS;QACX,CAAC;QAED,MAAM,cAAc,GAAG,IAAA,oCAA0B,EAAC,cAAc,CAAC,CAAC;QAElE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC;QACzC,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC;IAE3F,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAE,KAAK;QACf,UAAU,EAAE,GAAG;QACf,YAAY,EAAE,IAAI;KACF,CAAC;IAEnB,MAAM,iBAAiB,GAAG,KAAK,KAAK,cAAc,CAAC;IAEnD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,aAAa,CAAC,MAAM,GAAG,cAAc,CAAC;IACxC,CAAC;IAED,OAAO;QACL,GAAG,aAAa;QAChB,GAAG,OAAO;KACX,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,oBAAoB,CAAC"}

package/eslint.config.mjs

@@ -1,55 +1,35 @@
-import globals from "globals";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
-
-export default [...compat.extends("eslint:recommended"), {
+import jsdoc from 'eslint-plugin-jsdoc';
+import eslint from '@eslint/js';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+import { globalIgnores } from 'eslint/config';
+
+export default tseslint.config(
+  globalIgnores([ '**/dist/', '**/coverage/' ]),
+  {
     languageOptions: {
-        globals: {
-            ...globals.node,
-            ...globals.mocha,
-        },
-
-        ecmaVersion: 2018,
-        sourceType: "commonjs",
+      globals: {
+        ...globals.node,
+      },
     },
-
-    rules: {
-        "comma-style": "error",
-        "consistent-this": ["error", "_this"],
-
-        indent: ["error", 2, {
-            SwitchCase: 1,
-            VariableDeclarator: 2,
-        }],
-
-        "keyword-spacing": "error",
-        "no-multi-spaces": "off",
-        "no-spaced-func": "error",
-        "no-trailing-spaces": "error",
-        quotes: ["error", "single"],
-        semi: ["error", "never"],
-        curly: ["error"],
-        "prefer-arrow-callback": "error",
-        "space-before-blocks": "error",
-
-        "space-before-function-paren": [1, {
-            anonymous: "always",
-            named: "never",
-        }],
-
-        "space-infix-ops": "error",
-        "space-unary-ops": "error",
-        "no-return-await": "error",
-        eqeqeq: "error",
+    plugins: {
+      jsdoc,
     },
-}];
+    rules: {
+      semi: ['error', 'always'],
+      quotes: ['error', 'single'],
+      'jsdoc/require-jsdoc': ['error', {
+        require: {
+          ArrowFunctionExpression: true,
+          ClassDeclaration: true,
+          ClassExpression: true,
+          FunctionDeclaration: true,
+          FunctionExpression: true,
+          MethodDefinition: true,
+        },
+      }],
+    }
+  },
+  eslint.configs.recommended,
+  tseslint.configs.recommended
+);

package/examples/credentials/createAccountCredential.ts

@@ -0,0 +1,27 @@
+import { Schema, CredentialFactory } from '../../src';
+
+const accountSchema = new Schema({
+  id: {},
+  username: { required: true },
+  createdAt: { format: 'date-time', required: true },
+  dateOfBirth: { format: 'date' }
+}, 'Account');
+
+const factory = new CredentialFactory('https://example.com/schema/AccountV1', [ accountSchema ]);
+
+/** Creates account credetial for username */
+const createAccountCredential = (holder: string, username: string) => {
+  const id = `https://example.com/account/${username}`;
+
+  const createdAt = new Date().toISOString();
+
+  const subject = {
+    id: holder,
+    username,
+    createdAt
+  };
+
+  return factory.createCredential(id, holder, subject);
+};
+
+export default createAccountCredential;

package/examples/credentials/createMineSweeperScoreCredential.ts

@@ -0,0 +1,115 @@
+import { Schema, CredentialFactory } from '../../src';
+
+const GAME_NAME = 'MineSweeper';
+const GAME_VERSION = '1.0';
+
+const SCHEMA_ORG_URI = 'https://schema.org/';
+
+const playerSchema = new Schema({
+  id: {},
+  hasVideoGameScore: {
+    $ref: 'VideoGameScore',
+    required: true
+  }
+}, 'Player');
+
+const videoGameSchema = new Schema({
+  id: {},
+  name: {
+    type: 'string',
+    required: true
+  },
+  version: {
+    type: 'string',
+    required: true
+  }
+}, 'VideoGame', SCHEMA_ORG_URI);
+
+const videoGameScoreSchema = new Schema({
+  game: {
+    $ref: 'VideoGame',
+    required: true
+  },
+  wins: {
+    type: 'integer',
+    required: true
+  },
+  losses: {
+    type: 'integer',
+    required: true
+  },
+  winRate: {
+    type: 'number',
+    required: true
+  },
+  bestScore: {
+    type: 'integer',
+    required: true
+  },
+  // TODO: Add duration as format:
+  endurance: {
+    type: 'string',
+    '@type': 'schema:Duration',
+    required: true,
+  },
+  dateCreated: {
+    type: 'string',
+    'format': 'date-time',
+    required: true
+  },
+  bestRoundTime: {
+    type: 'integer',
+    required: true
+  }
+  // difficultyLevel:
+  //   enum:
+  //     - EASY
+  //     - MEDIUM
+  //     - HARD
+  //   required: true
+}, 'VideoGameScore');
+
+const CREDENTIAL_URI = `https://example.com/schema/${GAME_NAME}ScoreV1`;
+
+const SCHEMAS = [
+  playerSchema,
+  videoGameSchema,
+  videoGameScoreSchema
+];
+
+const factory = new CredentialFactory(CREDENTIAL_URI, SCHEMAS);
+
+/** Creates score credential for MineSweeper game */
+const createMineSweeperScoreCredential = (
+  gameId: string,
+  playerId: string,
+  playerScore: {
+    wins: number;
+    losses: number;
+    winRate: number;
+    bestScore: number;
+    endurance: string;
+    dateCreated: string;
+    bestRoundTime: number;
+  }
+) => {
+  const credentialId = 'https://example.com/credentials/CREDENTIAL_ID';
+
+  const game = {
+    id: gameId,
+    name: GAME_NAME,
+    version: GAME_VERSION
+  };
+
+  const player = {
+    id: playerId,
+    hasVideoGameScore: {
+      ...playerScore,
+      game
+    }
+  };
+
+  return factory.createCredential(credentialId, playerId, player);
+};
+
+export default createMineSweeperScoreCredential;

package/examples/index.ts

@@ -0,0 +1,7 @@
+import createAccountCredential from './credentials/createAccountCredential';
+import createMineSweeperScoreCredential from './credentials/createMineSweeperScoreCredential';
+
+export {
+  createAccountCredential,
+  createMineSweeperScoreCredential
+};

package/examples/schemas/FavoriteItemSchema.ts

@@ -0,0 +1,27 @@
+import { Schema } from '../../src';
+
+const FavoriteItemSchema = new Schema({
+  id: {
+    required: true,
+  },
+  name: {
+    required: true,
+  },
+  description: {},
+  status: {
+    $ref: 'Status',
+    default: 'Pending',
+  },
+  categories: {
+    items: {
+      enum: [
+        'Education',
+        'Work',
+        'Lifestyle',
+        'Games'
+      ]
+    }
+  }
+}, 'FavoriteItemSchema');
+
+export default FavoriteItemSchema;

package/examples/{Preferences.yaml → schemas/Preferences.yaml}

@@ -1,5 +1,7 @@
 age:
   type: number
+  minimum: 0
+  maximum: 199
 
 height:
   type: number

package/examples/schemas/PreferencesSchema.ts

@@ -0,0 +1,29 @@
+import { Schema } from '../../src';
+
+const PreferencesSchema = new Schema({
+  age:{
+    type: 'number',
+    minimum: 0,
+    maximum: 199,
+  },
+  height: {
+    type: 'number'
+  },
+  isNotificationEnabled: {
+    type: 'boolean'
+  },
+  shouldSendEmails: {
+    type: 'boolean'
+  },
+  shouldSendSMS: {
+    type: 'boolean'
+  },
+  hasPaymentMethod: {
+    type: 'boolean'
+  },
+  hasPositiveBalance: {
+    type: 'boolean'
+  }
+}, 'PreferencesSchema');
+
+export default PreferencesSchema;

package/examples/schemas/ProfileSchema.ts

@@ -0,0 +1,91 @@
+import { Schema } from '../../src';
+
+const ProfileSchema = new Schema({
+  name: {
+    required: true,
+    minLength: 3,
+    maxLength: 128,
+  },
+  // NOTE: Referenced enum:
+  status: {
+    $ref: 'Status',
+    default: 'Pending',
+  },
+  // NOTE: Nested enum:
+  gender: {
+    enum: [ 'Male', 'Female', 'Other' ],
+    default: 'Other'
+  },
+  // NOTE: Nested object:
+  contactDetails: {
+    required: true,
+    properties: {
+      email: {
+        type: 'string',
+        format: 'email',
+        required: true,
+      },
+      secondaryEmail: {
+        type: 'string',
+        format: 'email',
+      },
+      mobileNumber: {
+        type: 'string',
+        pattern: '^[0-9]{1,20}$',
+        default: '380504112171',
+      }
+    }
+  },
+  // NOTE: Array of nested objects:
+  locations: {
+    items: {
+      properties: {
+        name: {
+          required: true,
+        },
+        address: {
+          properties: {
+            country: {
+              required: true,
+              default: 'Ukraine',
+            },
+            city: {
+              required: true,
+            },
+            addressLine1: {
+              required: true,
+            },
+            addressLine2: {},
+            zip: {
+              required: true,
+            },
+            type: {
+              enum: [ 'Primary', 'Secondary' ],
+              default: 'Secondary'
+            }
+          },
+        }
+      }
+    }
+  },
+  // NOTE: Array of strings:
+  tags: {
+    type: 'array',
+  },
+  // NOTE: Array of referenced objects:
+  favoriteItems: {
+    items: {
+      $ref: 'FavoriteItem',
+    }
+  },
+  // NOTE: Referenced object:
+  preferences: {
+    $ref: 'Preferences',
+  },
+  // NOTE: Nested object without properties:
+  hash: {
+    type: 'object',
+  }
+}, 'ProfileSchema');
+
+export default ProfileSchema;

package/examples/schemas/Status.yaml

@@ -0,0 +1,3 @@
+enum:
+  - PENDING
+  - ACTIVE