@bifold/oca 1.0.0

package/build/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./data"), exports);
+__exportStar(require("./overlay"), exports);

package/build/interfaces/overlay/OverlayBundleAttribute.interface.d.ts

@@ -0,0 +1,9 @@
+export default interface IOverlayBundleAttribute {
+    name: string;
+    type: string;
+    information?: Record<string, string>;
+    label?: Record<string, string>;
+    format?: string;
+    characterEncoding?: string;
+    standard?: string;
+}

package/build/interfaces/overlay/OverlayBundleAttribute.interface.js

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

package/build/interfaces/overlay/OverlayBundleMetadata.interface.d.ts

@@ -0,0 +1,9 @@
+export default interface IOverlayBundleMetadata {
+    name: Record<string, string>;
+    description: Record<string, string>;
+    credentialHelpText?: Record<string, string>;
+    credentialSupportUrl?: Record<string, string>;
+    issuer: Record<string, string>;
+    issuerDescription?: Record<string, string>;
+    issuerUrl?: Record<string, string>;
+}

package/build/interfaces/overlay/OverlayBundleMetadata.interface.js

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

package/build/interfaces/overlay/index.d.ts

@@ -0,0 +1,3 @@
+import IOverlayBundleAttribute from './OverlayBundleAttribute.interface';
+import IOverlayBundleMetadata from './OverlayBundleMetadata.interface';
+export { IOverlayBundleAttribute, IOverlayBundleMetadata };

package/build/interfaces/overlay/index.js

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

package/build/legacy/index.d.ts

@@ -0,0 +1,3 @@
+export * from './resolver/oca';
+export * from './resolver/record';
+export * from './resolver/remote-oca';

package/build/legacy/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resolver/oca"), exports);
+__exportStar(require("./resolver/record"), exports);
+__exportStar(require("./resolver/remote-oca"), exports);

package/build/legacy/resolver/oca.d.ts

@@ -0,0 +1,99 @@
+import { IOverlayBundleData } from '../../interfaces';
+import { BaseOverlay, BrandingOverlay, CaptureBase, CharacterEncodingOverlay, FormatOverlay, LabelOverlay, LegacyBrandingOverlay, MetaOverlay, OverlayBundle, OverlayType } from '../../types';
+import { Field } from './record';
+export declare const BrandingOverlayType: {
+    readonly Branding01: OverlayType.Branding01;
+    readonly Branding10: OverlayType.Branding10;
+    readonly Branding11: OverlayType.Branding11;
+};
+export type BrandingOverlayType = (typeof BrandingOverlayType)[keyof typeof BrandingOverlayType];
+export interface CredentialOverlay<T> {
+    bundle?: OCABundle;
+    presentationFields?: Field[];
+    metaOverlay?: MetaOverlay;
+    brandingOverlay?: T;
+}
+export interface OCABundleType {
+    get captureBase(): CaptureBase;
+    get metaOverlay(): MetaOverlay | undefined;
+    get labelOverlay(): LabelOverlay | undefined;
+    get formatOverlay(): FormatOverlay | undefined;
+    get characterEncodingOverlay(): CharacterEncodingOverlay | undefined;
+    get brandingOverlay(): BrandingOverlay | LegacyBrandingOverlay | undefined;
+}
+export type OCABundleResolveParams = {
+    identifiers: Identifiers;
+    language?: string;
+};
+export type OCABundleResolveDefaultParams = {
+    identifiers: Identifiers;
+    meta?: Meta;
+    language?: string;
+};
+export type OCABundleResolveAllParams = {
+    identifiers: Identifiers;
+    attributes?: Array<Field>;
+    meta?: Meta;
+    language?: string;
+};
+export type OCABundleResolvePresentationFieldsParams = {
+    identifiers: Identifiers;
+    attributes: Array<Field>;
+    language?: string;
+};
+export interface OCABundleResolverType {
+    resolve(params: OCABundleResolveParams): Promise<OCABundle | undefined>;
+    resolveDefaultBundle(params: OCABundleResolveDefaultParams): Promise<OCABundle | undefined>;
+    presentationFields(params: OCABundleResolvePresentationFieldsParams): Promise<Field[]>;
+    resolveAllBundles(params: OCABundleResolveAllParams): Promise<CredentialOverlay<BaseOverlay | BrandingOverlay | LegacyBrandingOverlay>>;
+    getBrandingOverlayType(): BrandingOverlayType;
+}
+export interface OCABundleResolverOptions {
+    language?: string;
+    brandingOverlayType?: BrandingOverlayType;
+}
+export interface Identifiers {
+    schemaId?: string;
+    credentialDefinitionId?: string;
+    templateId?: string;
+}
+export interface Meta {
+    alias?: string;
+    credName?: string;
+    credConnectionId?: string;
+    logo?: string;
+}
+export declare class OCABundle implements OCABundleType {
+    private bundle;
+    private options;
+    constructor(bundle: OverlayBundle, options?: OCABundleResolverOptions);
+    get captureBase(): CaptureBase;
+    get characterEncodingOverlay(): CharacterEncodingOverlay | undefined;
+    get formatOverlay(): FormatOverlay | undefined;
+    get labelOverlay(): LabelOverlay | undefined;
+    get metaOverlay(): MetaOverlay | undefined;
+    get brandingOverlay(): BrandingOverlay | LegacyBrandingOverlay | undefined;
+    buildOverlay(name: string, language: string): MetaOverlay;
+    private getOverlay;
+}
+export declare class DefaultOCABundleResolver implements OCABundleResolverType {
+    protected bundles: Record<string, OverlayBundle | string>;
+    protected options: OCABundleResolverOptions;
+    private _log?;
+    constructor(bundlesData?: Record<string, IOverlayBundleData | string>, options?: OCABundleResolverOptions);
+    /**
+     * Sets the log value.
+     * @param value - The new value for the log.
+     */
+    set log(value: any);
+    /**
+     * Get the log value.
+     */
+    get log(): any;
+    getBrandingOverlayType(): BrandingOverlayType;
+    private getDefaultBundle;
+    resolveDefaultBundle(params: OCABundleResolveDefaultParams): Promise<OCABundle | undefined>;
+    resolve(params: OCABundleResolveParams): Promise<OCABundle | undefined>;
+    presentationFields(params: OCABundleResolvePresentationFieldsParams): Promise<Field[]>;
+    resolveAllBundles(params: OCABundleResolveAllParams): Promise<CredentialOverlay<BaseOverlay | BrandingOverlay | LegacyBrandingOverlay>>;
+}

package/build/legacy/resolver/oca.js

@@ -0,0 +1,239 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultOCABundleResolver = exports.OCABundle = exports.BrandingOverlayType = void 0;
+const lodash_startcase_1 = __importDefault(require("lodash.startcase"));
+const constants_1 = require("../../constants");
+const types_1 = require("../../types");
+const color_1 = require("../../utils/color");
+const credential_definition_1 = require("../../utils/credential-definition");
+exports.BrandingOverlayType = {
+    Branding01: types_1.OverlayType.Branding01,
+    Branding10: types_1.OverlayType.Branding10,
+    Branding11: types_1.OverlayType.Branding11,
+};
+class OCABundle {
+    constructor(bundle, options) {
+        var _a, _b;
+        this.bundle = bundle;
+        this.options = {
+            brandingOverlayType: (_a = options === null || options === void 0 ? void 0 : options.brandingOverlayType) !== null && _a !== void 0 ? _a : exports.BrandingOverlayType.Branding10,
+            language: (_b = options === null || options === void 0 ? void 0 : options.language) !== null && _b !== void 0 ? _b : constants_1.defaultBundleLanguage,
+        };
+        // Make bundle overlay type come from options.brandingOverlayType
+        this.bundle.overlays.forEach((o) => {
+            if (o.type === exports.BrandingOverlayType.Branding10 || o.type === exports.BrandingOverlayType.Branding11) {
+                o.type = this.options.brandingOverlayType;
+            }
+        });
+    }
+    get captureBase() {
+        const overlay = this.bundle.captureBase;
+        if (!overlay) {
+            throw new Error('Capture Base must be defined');
+        }
+        return overlay;
+    }
+    get characterEncodingOverlay() {
+        return this.getOverlay(types_1.OverlayType.CharacterEncoding10);
+    }
+    get formatOverlay() {
+        return this.getOverlay(types_1.OverlayType.Format10);
+    }
+    get labelOverlay() {
+        return this.getOverlay(types_1.OverlayType.Label10, this.options.language);
+    }
+    get metaOverlay() {
+        return this.getOverlay(types_1.OverlayType.Meta10, this.options.language);
+    }
+    get brandingOverlay() {
+        var _a;
+        return this.getOverlay(((_a = this.options) === null || _a === void 0 ? void 0 : _a.brandingOverlayType) || exports.BrandingOverlayType.Branding10);
+    }
+    buildOverlay(name, language) {
+        return new types_1.MetaOverlay({
+            capture_base: '',
+            type: types_1.OverlayType.Meta10,
+            name,
+            language,
+            description: '',
+            credential_help_text: '',
+            credential_support_url: '',
+            issuer: '',
+            issuer_description: '',
+            issuer_url: '',
+        });
+    }
+    getOverlay(type, language) {
+        if (type === types_1.OverlayType.CaptureBase10) {
+            return this.bundle.captureBase;
+        }
+        if (language !== undefined) {
+            // we want to return branding even if there isn't a bundle for a given language
+            const overlay = this.bundle.overlays.find((item) => (item.language === undefined && item.type === type.toString()) ||
+                (item.type === type.toString() && item.language === language));
+            if (overlay) {
+                return overlay;
+            }
+        }
+        return this.bundle.overlays.find((item) => item.type === type.toString());
+    }
+}
+exports.OCABundle = OCABundle;
+class DefaultOCABundleResolver {
+    constructor(bundlesData = {}, options) {
+        var _a, _b, _c;
+        this.bundles = {};
+        for (const cid in bundlesData) {
+            try {
+                if (typeof bundlesData[cid] !== 'string') {
+                    this.bundles[cid] = new types_1.OverlayBundle(cid, bundlesData[cid]);
+                }
+                else {
+                    this.bundles[cid] = bundlesData[cid];
+                }
+            }
+            catch (error) {
+                // might get an error trying to parse javascript's default value
+                (_a = this.log) === null || _a === void 0 ? void 0 : _a.error(`Error parsing bundle for ${cid}`, error);
+            }
+        }
+        this.options = {
+            brandingOverlayType: (_b = options === null || options === void 0 ? void 0 : options.brandingOverlayType) !== null && _b !== void 0 ? _b : exports.BrandingOverlayType.Branding10,
+            language: (_c = options === null || options === void 0 ? void 0 : options.language) !== null && _c !== void 0 ? _c : constants_1.defaultBundleLanguage,
+        };
+    }
+    /**
+     * Sets the log value.
+     * @param value - The new value for the log.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    set log(value) {
+        this._log = value;
+    }
+    /**
+     * Get the log value.
+     */
+    get log() {
+        return this._log;
+    }
+    getBrandingOverlayType() {
+        var _a;
+        return (_a = this.options.brandingOverlayType) !== null && _a !== void 0 ? _a : exports.BrandingOverlayType.Branding10;
+    }
+    getDefaultBundle(params) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        if (!params.language) {
+            params.language = constants_1.defaultBundleLanguage;
+        }
+        const metaOverlay = {
+            capture_base: '',
+            type: types_1.OverlayType.Meta10,
+            name: (0, lodash_startcase_1.default)((_b = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.credName) !== null && _b !== void 0 ? _b : (0, credential_definition_1.parseCredDefFromId)((_c = params.identifiers) === null || _c === void 0 ? void 0 : _c.credentialDefinitionId, (_d = params.identifiers) === null || _d === void 0 ? void 0 : _d.schemaId)),
+            issuer: ((_e = params.meta) === null || _e === void 0 ? void 0 : _e.alias) || ((_f = params.meta) === null || _f === void 0 ? void 0 : _f.credConnectionId) || 'Unknown Contact',
+            language: (_g = params.language) !== null && _g !== void 0 ? _g : (_h = this.options) === null || _h === void 0 ? void 0 : _h.language,
+            description: '',
+            credential_help_text: '',
+            credential_support_url: '',
+            issuer_description: '',
+            issuer_url: '',
+        };
+        let colorHash = 'default';
+        if (metaOverlay === null || metaOverlay === void 0 ? void 0 : metaOverlay.name) {
+            colorHash = metaOverlay.name;
+        }
+        else if (metaOverlay === null || metaOverlay === void 0 ? void 0 : metaOverlay.issuer) {
+            colorHash = metaOverlay.issuer;
+        }
+        const brandingOverlay01 = {
+            capture_base: '',
+            type: types_1.OverlayType.Branding01,
+            background_color: (0, color_1.generateColor)(colorHash),
+        };
+        const brandingOverlay10 = {
+            capture_base: '',
+            type: types_1.OverlayType.Branding10,
+            primary_background_color: (0, color_1.generateColor)(colorHash),
+        };
+        const brandingOverlay11 = {
+            capture_base: '',
+            type: types_1.OverlayType.Branding11,
+            primary_background_color: '#FFFFFF',
+            secondary_background_color: (0, color_1.generateColor)(colorHash),
+        };
+        let brandingOverlay = this.getBrandingOverlayType() === exports.BrandingOverlayType.Branding01 ? brandingOverlay01 : brandingOverlay10;
+        if (this.getBrandingOverlayType() === exports.BrandingOverlayType.Branding11) {
+            brandingOverlay = brandingOverlay11;
+        }
+        const bundle = new types_1.OverlayBundle((_j = params.identifiers) === null || _j === void 0 ? void 0 : _j.credentialDefinitionId, {
+            capture_base: {
+                attributes: {},
+                classification: '',
+                type: types_1.OverlayType.CaptureBase10,
+                flagged_attributes: [],
+            },
+            overlays: [metaOverlay, brandingOverlay],
+        });
+        return Promise.resolve(new OCABundle(bundle, Object.assign(Object.assign({}, this.options), { language: (_k = params.language) !== null && _k !== void 0 ? _k : this.options.language })));
+    }
+    resolveDefaultBundle(params) {
+        return this.getDefaultBundle(params);
+    }
+    resolve(params) {
+        var _a, _b, _c;
+        const language = params.language || constants_1.defaultBundleLanguage;
+        for (const item of [
+            (_a = params.identifiers) === null || _a === void 0 ? void 0 : _a.credentialDefinitionId,
+            (_b = params.identifiers) === null || _b === void 0 ? void 0 : _b.schemaId,
+            (_c = params.identifiers) === null || _c === void 0 ? void 0 : _c.templateId,
+        ]) {
+            if (item && this.bundles[item] !== undefined) {
+                let bundle = this.bundles[item];
+                // if it is a string, it is a reference/alias to another one bundle
+                if (typeof bundle === 'string') {
+                    bundle = this.bundles[bundle];
+                }
+                return Promise.resolve(new OCABundle(bundle, Object.assign(Object.assign({}, this.options), { language: language !== null && language !== void 0 ? language : this.options.language })));
+            }
+        }
+        return Promise.resolve(undefined);
+    }
+    async presentationFields(params) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const bundle = await this.resolve(params);
+        let presentationFields = [...params.attributes];
+        if ((_a = bundle === null || bundle === void 0 ? void 0 : bundle.captureBase) === null || _a === void 0 ? void 0 : _a.attributes) {
+            // if the oca branding has the attributes set, only display those attributes
+            const bundleFields = Object.keys(bundle.captureBase.attributes);
+            presentationFields = presentationFields.filter((item) => item.name && bundleFields.includes(item.name));
+            for (let i = 0; i < presentationFields.length; i++) {
+                const presentationField = presentationFields[i];
+                const key = presentationField.name || '';
+                if (bundle.captureBase.attributes[key]) {
+                    presentationField.label = (_b = bundle === null || bundle === void 0 ? void 0 : bundle.labelOverlay) === null || _b === void 0 ? void 0 : _b.attributeLabels[key];
+                    presentationField.format = (_c = bundle === null || bundle === void 0 ? void 0 : bundle.formatOverlay) === null || _c === void 0 ? void 0 : _c.attributeFormats[key];
+                    presentationField.type = (_e = (_d = bundle === null || bundle === void 0 ? void 0 : bundle.captureBase) === null || _d === void 0 ? void 0 : _d.attributes) === null || _e === void 0 ? void 0 : _e[key];
+                    presentationField.encoding = (_g = (_f = bundle === null || bundle === void 0 ? void 0 : bundle.characterEncodingOverlay) === null || _f === void 0 ? void 0 : _f.attributeCharacterEncoding) === null || _g === void 0 ? void 0 : _g[key];
+                }
+            }
+        }
+        return presentationFields;
+    }
+    async resolveAllBundles(params) {
+        var _a;
+        const [bundle, defaultBundle] = await Promise.all([this.resolve(params), this.resolveDefaultBundle(params)]);
+        const fields = params.attributes
+            ? await this.presentationFields(Object.assign(Object.assign({}, params), { attributes: params.attributes }))
+            : [];
+        const overlayBundle = bundle !== null && bundle !== void 0 ? bundle : defaultBundle;
+        const metaOverlay = overlayBundle === null || overlayBundle === void 0 ? void 0 : overlayBundle.metaOverlay;
+        const brandingOverlay = overlayBundle === null || overlayBundle === void 0 ? void 0 : overlayBundle.brandingOverlay;
+        if (brandingOverlay && 'logo' in brandingOverlay && ((_a = params.meta) === null || _a === void 0 ? void 0 : _a.logo)) {
+            brandingOverlay.logo = params.meta.logo;
+        }
+        return { bundle: overlayBundle, presentationFields: fields, metaOverlay, brandingOverlay };
+    }
+}
+exports.DefaultOCABundleResolver = DefaultOCABundleResolver;

package/build/legacy/resolver/record.d.ts

@@ -0,0 +1,50 @@
+import { AnonCredsNonRevokedInterval, AnonCredsProofRequestRestriction } from '@credo-ts/anoncreds';
+export interface FieldParams {
+    name: string;
+    format?: string;
+    type?: string;
+    encoding?: string;
+    mimeType?: string;
+    revoked?: boolean;
+    credentialId?: string;
+    label?: string;
+    restrictions?: AnonCredsProofRequestRestriction[];
+    nonRevoked?: AnonCredsNonRevokedInterval;
+}
+export interface AttributeParams extends FieldParams {
+    value: string | number | null;
+    revealed?: boolean;
+    hasError?: boolean;
+}
+export interface PredicateParams extends FieldParams {
+    pValue: string | number | null;
+    pType: string;
+    parameterizable?: boolean;
+    satisfied?: boolean;
+}
+export declare class Field {
+    name: string;
+    format?: string;
+    type?: string;
+    encoding?: string;
+    mimeType?: string;
+    revoked?: boolean;
+    credentialId?: string;
+    label?: string;
+    restrictions?: AnonCredsProofRequestRestriction[];
+    nonRevoked?: AnonCredsNonRevokedInterval;
+    protected constructor(params: FieldParams);
+}
+export declare class Attribute extends Field {
+    value: string | number | null;
+    revealed?: boolean;
+    hasError?: boolean;
+    constructor(params: AttributeParams);
+}
+export declare class Predicate extends Field {
+    pValue: string | number | null;
+    pType: string;
+    parameterizable?: boolean;
+    satisfied?: boolean;
+    constructor(params: PredicateParams);
+}

package/build/legacy/resolver/record.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Predicate = exports.Attribute = exports.Field = void 0;
+class Field {
+    constructor(params) {
+        this.name = params.name;
+        this.format = params.format;
+        this.type = params.type;
+        this.encoding = params.encoding;
+        this.mimeType = params.mimeType;
+        this.revoked = params.revoked;
+        this.credentialId = params.credentialId;
+        this.label = params.label;
+        this.restrictions = params.restrictions;
+        this.nonRevoked = params.nonRevoked;
+    }
+}
+exports.Field = Field;
+class Attribute extends Field {
+    constructor(params) {
+        super(params);
+        this.value = params.value;
+        this.revealed = params.revealed;
+        this.hasError = params.hasError;
+    }
+}
+exports.Attribute = Attribute;
+class Predicate extends Field {
+    constructor(params) {
+        super(params);
+        this.pValue = params.pValue;
+        this.pType = params.pType;
+        this.parameterizable = params.parameterizable;
+        this.satisfied = params.satisfied;
+    }
+}
+exports.Predicate = Predicate;