@bifold/oca 1.0.0

package/README.md

@@ -0,0 +1,33 @@
+<p align="center">
+  <br />
+  <img
+    alt="Hyperledger Aries logo"
+    src="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
+    height="250px"
+  />
+</p>
+<h1 align="center"><b>Aries Bifold - OCA</b></h1>
+<p align="center">
+  <a
+    href="https://raw.githubusercontent.com/hyperledger/aries-mobile-agent-react-native/main/LICENSE"
+    ><img
+      alt="License"
+      src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
+  /></a>
+  <a href="https://www.typescriptlang.org/"
+    ><img
+      alt="typescript"
+      src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg"
+  /></a>
+    <a href="https://www.npmjs.com/package/@aries-bifold/oca"
+    ><img
+      alt="@aries-bifold/oca version"
+      src="https://img.shields.io/npm/v/@aries-bifold/oca"
+  /></a>
+
+</p>
+<br />
+
+Aries Bifold OCA provides an interpreter for OCA ([Overlay Capture Architecture](https://humancolossus.foundation/blog/cjzegoi58xgpfzwxyrqlroy48dihwz)) bundles. More details to come.
+
+_Package structure inspired / adapted from the [credo-ts](https://github.com/openwallet-foundation/credo-ts) project_

package/build/__tests__/remote.test.d.ts

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

package/build/__tests__/remote.test.js

@@ -0,0 +1,162 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const fs_1 = __importDefault(require("fs"));
+const react_native_fs_1 = require("react-native-fs");
+const constants_1 = require("../constants");
+const remote_oca_1 = require("../legacy/resolver/remote-oca");
+const bundleFileName = 'bundle.json';
+const ocaPath = `${__dirname}/fixtures/${constants_1.ocaCacheDataFileName}`;
+const ocaAsString = fs_1.default.readFileSync(ocaPath, 'utf8');
+const indexPath = `${__dirname}/fixtures/${constants_1.defaultBundleIndexFileName}`;
+const indexAsString = fs_1.default.readFileSync(indexPath, 'utf8');
+const bundlePath = `${__dirname}/fixtures/${bundleFileName}`;
+const bundleAsString = fs_1.default.readFileSync(bundlePath, 'utf8');
+const initialEtag = '3379dc5c38ac34ab';
+const changedEtag = '4c0afc9bfdb3bf6b';
+const keysToUpdated = [
+    '79e343ab4362d93974cdf78b00a916a5b3659178dfd170fcff90f1b5f10ceb72',
+    '29bf8f8729f235450980d0b273f9ca49b7ab73b7358467bf52b311bf40464bb0',
+];
+// Testing person credential as an example
+const personSha = '9187f651eab59811d8ec1c1257628c08f6daa1eb520bf379f022425f3a9701cf';
+const qualifiedCredDefId = 'did:indy:candy:RGjWbW1eycP7FrMf4QJvX8/anoncreds/v0/CLAIM_DEF/13/Person';
+const qualifiedSchemaId = 'did:indy:candy:RGjWbW1eycP7FrMf4QJvX8/anoncreds/v0/SCHEMA/Person/1.0';
+const getMock = jest.fn().mockImplementation((url) => {
+    const fileName = url.split('/').pop();
+    switch (fileName) {
+        case 'ocabundles.json':
+            return Promise.resolve({
+                status: 200,
+                data: JSON.parse(indexAsString),
+                headers: { etag: initialEtag },
+            });
+        case 'OCABundle.json':
+            return Promise.resolve({
+                status: 200,
+                data: JSON.parse(bundleAsString),
+            });
+        default:
+            return Promise.reject(new Error('Not Found'));
+    }
+});
+jest.mock('axios', () => ({
+    create: jest.fn().mockReturnValue({
+        get: jest.fn(),
+    }),
+}));
+jest.useFakeTimers({ legacyFakeTimers: true });
+jest.mock('react-native-fs', () => ({
+    exists: jest.fn().mockResolvedValue(true),
+    mkdir: jest.fn().mockResolvedValue(true),
+    readFile: jest.fn().mockImplementation((filePath) => {
+        const fileName = filePath.split('/').pop();
+        switch (fileName) {
+            case constants_1.ocaCacheDataFileName: {
+                return Promise.resolve(ocaAsString);
+            }
+            case constants_1.defaultBundleIndexFileName:
+                return Promise.resolve(indexAsString);
+            case personSha:
+                return Promise.resolve(bundleAsString);
+            default:
+                return Promise.resolve('{}');
+        }
+    }),
+    writeFile: jest.fn().mockResolvedValue(true),
+    unlink: jest.fn().mockResolvedValue(true),
+}));
+describe('RemoteOCABundleResolver', () => {
+    let resolver;
+    beforeEach(() => {
+        resolver = new remote_oca_1.RemoteOCABundleResolver('http://example.com');
+        // resolver.log = new MiniLogger()
+        jest.clearAllMocks();
+        // @ts-expect-error some weird type
+        axios_1.default.create().get.mockImplementation(getMock);
+    });
+    it('should be created', async () => {
+        expect(resolver).toBeTruthy();
+        expect(resolver).toBeInstanceOf(remote_oca_1.RemoteOCABundleResolver);
+        expect(resolver).toHaveProperty('indexFileName', constants_1.defaultBundleIndexFileName);
+        expect(resolver).toHaveProperty('cacheDataFileName', constants_1.ocaCacheDataFileName);
+        expect(resolver['axiosInstance']).not.toBeNull();
+        expect(axios_1.default.create().get).toHaveBeenCalledTimes(0);
+        expect(resolver.indexFileEtag).toEqual('');
+        expect(resolver['indexFile']).toMatchSnapshot();
+    });
+    it('should update demand', async () => {
+        await resolver.checkForUpdates();
+        expect(axios_1.default.create().get).toHaveBeenCalledTimes(16); // 1 index + 15 bundles
+        expect(react_native_fs_1.writeFile).toHaveBeenCalledTimes(17); // 1 index + 15 bundles + 1 cache
+        expect(react_native_fs_1.readFile).toHaveBeenCalledTimes(1); // 1 cache
+        expect(react_native_fs_1.unlink).toHaveBeenCalledTimes(0); // 0 deletes
+        expect(react_native_fs_1.exists).toHaveBeenCalledTimes(3); // 1 index + 1 cache + 1 directory
+        expect(react_native_fs_1.mkdir).toHaveBeenCalledTimes(0); // mock always return true
+        expect(resolver.indexFileEtag).toEqual(initialEtag);
+        expect(resolver['indexFile']).toMatchSnapshot();
+    });
+    it.skip('should check index periodically', async () => {
+        await resolver.checkForUpdates();
+        await resolver.checkForUpdates();
+        await resolver.checkForUpdates();
+        expect(axios_1.default.create().get).toHaveBeenCalledTimes(18); // 3 index + 15 bundles
+        expect(react_native_fs_1.writeFile).toHaveBeenCalledTimes(17); // 1 index + 15 bundles + 1 cache
+        expect(react_native_fs_1.readFile).toHaveBeenCalledTimes(1);
+        expect(react_native_fs_1.unlink).toHaveBeenCalledTimes(0);
+        expect(react_native_fs_1.exists).toHaveBeenCalledTimes(5);
+        expect(react_native_fs_1.mkdir).toHaveBeenCalledTimes(0);
+    });
+    it('should check fetch updated bundles', async () => {
+        await resolver.checkForUpdates();
+        expect(axios_1.default.create().get).toHaveBeenCalledTimes(16); // 1 index + 15 bundles
+        expect(resolver.indexFileEtag).toEqual(initialEtag);
+        const newIndexAsJSON = JSON.parse(indexAsString);
+        for (const key of Object.keys(newIndexAsJSON)) {
+            if (keysToUpdated.includes(newIndexAsJSON[key].sha256)) {
+                newIndexAsJSON[key].sha256 = newIndexAsJSON[key].sha256.slice(0, 7);
+            }
+        }
+        // @ts-expect-error some weird type
+        axios_1.default.create().get.mockImplementation((url) => {
+            const fileName = url.split('/').pop();
+            switch (fileName) {
+                case 'ocabundles.json':
+                    return Promise.resolve({
+                        status: 200,
+                        data: newIndexAsJSON,
+                        headers: { etag: changedEtag },
+                    });
+                case 'OCABundle.json':
+                    return Promise.resolve({
+                        status: 200,
+                        data: JSON.parse(bundleAsString),
+                    });
+                default:
+                    return Promise.reject(new Error('Not Found'));
+            }
+        });
+        await resolver.checkForUpdates();
+        expect(axios_1.default.create().get).toHaveBeenCalledTimes(19); // 2 index + 17 bundles
+        expect(react_native_fs_1.writeFile).toHaveBeenCalledTimes(21); // 2 index + 17 bundles + 2 cache
+        expect(react_native_fs_1.readFile).toHaveBeenCalledTimes(1);
+        expect(react_native_fs_1.unlink).toHaveBeenCalledTimes(2); // 2 deletes
+        expect(react_native_fs_1.exists).toHaveBeenCalledTimes(4); // 2 index + 1 cache + 1 directory
+        expect(react_native_fs_1.mkdir).toHaveBeenCalledTimes(0);
+        expect(resolver.indexFileEtag).toEqual(changedEtag);
+        expect(resolver['indexFile']).toMatchSnapshot();
+    });
+    it('should check unqualified cred def id as key if given qualified cred def id', async () => {
+        await resolver.checkForUpdates();
+        const bundle = await resolver.resolve({ identifiers: { credentialDefinitionId: qualifiedCredDefId } });
+        expect(bundle).toBeDefined();
+    });
+    it('should check unqualified schema id as key if given qualified schema id', async () => {
+        await resolver.checkForUpdates();
+        const bundle = await resolver.resolve({ identifiers: { schemaId: qualifiedSchemaId } });
+        expect(bundle).toBeDefined();
+    });
+});

package/build/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const ocaBundleStorageDirectory = "oca";
+export declare const ocaCacheDataFileName = "oca.json";
+export declare const defaultBundleIndexFileName = "ocabundles.json";
+export declare const defaultBundleLanguage = "en";

package/build/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultBundleLanguage = exports.defaultBundleIndexFileName = exports.ocaCacheDataFileName = exports.ocaBundleStorageDirectory = void 0;
+exports.ocaBundleStorageDirectory = 'oca';
+exports.ocaCacheDataFileName = 'oca.json';
+exports.defaultBundleIndexFileName = 'ocabundles.json';
+exports.defaultBundleLanguage = 'en';

package/build/formatters/credential/CredentialFormatter.d.ts

@@ -0,0 +1,8 @@
+import { CredentialExchangeRecord } from '@credo-ts/core';
+import { OverlayBundle } from '../../types';
+import LocalizedCredential from './LocalizedCredential';
+export default class CredentialFormatter {
+    #private;
+    constructor(bundle: OverlayBundle, record: CredentialExchangeRecord);
+    localizedCredential(language: string): LocalizedCredential | undefined;
+}

package/build/formatters/credential/CredentialFormatter.js

@@ -0,0 +1,32 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _CredentialFormatter_credentials;
+Object.defineProperty(exports, "__esModule", { value: true });
+const LocalizedCredential_1 = __importDefault(require("./LocalizedCredential"));
+class CredentialFormatter {
+    constructor(bundle, record) {
+        _CredentialFormatter_credentials.set(this, void 0);
+        __classPrivateFieldSet(this, _CredentialFormatter_credentials, bundle.languages.reduce((credentials, language) => {
+            credentials[language] = new LocalizedCredential_1.default(bundle, record, language);
+            return credentials;
+        }, {}), "f");
+    }
+    localizedCredential(language) {
+        return __classPrivateFieldGet(this, _CredentialFormatter_credentials, "f")[language];
+    }
+}
+_CredentialFormatter_credentials = new WeakMap();
+exports.default = CredentialFormatter;

package/build/formatters/credential/DisplayAttribute.d.ts

@@ -0,0 +1,11 @@
+import { CredentialPreviewAttribute, CredentialPreviewAttributeOptions } from '@credo-ts/core';
+import { IOverlayBundleAttribute as OverlayBundleAttributeOptions } from '../../interfaces/overlay';
+export default class DisplayAttribute extends CredentialPreviewAttribute {
+    characterEncoding: string | undefined;
+    standard: string | undefined;
+    format: string | undefined;
+    information: string | undefined;
+    label: string | undefined;
+    constructor(options: CredentialPreviewAttributeOptions, overlayOptions: OverlayBundleAttributeOptions, language: string);
+    toJSON(): Record<string, unknown>;
+}

package/build/formatters/credential/DisplayAttribute.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@credo-ts/core");
+class DisplayAttribute extends core_1.CredentialPreviewAttribute {
+    constructor(options, overlayOptions, language) {
+        var _a, _b;
+        super(options);
+        this.characterEncoding = overlayOptions.characterEncoding;
+        this.standard = overlayOptions.standard;
+        this.format = overlayOptions.format;
+        this.information = (_a = overlayOptions.information) === null || _a === void 0 ? void 0 : _a[language];
+        this.label = (_b = overlayOptions.label) === null || _b === void 0 ? void 0 : _b[language];
+    }
+    toJSON() {
+        return Object.assign(Object.assign({}, super.toJSON()), { format: this.format, information: this.information, label: this.label });
+    }
+}
+exports.default = DisplayAttribute;

package/build/formatters/credential/LocalizedCredential.d.ts

@@ -0,0 +1,13 @@
+import { CredentialExchangeRecord } from '@credo-ts/core';
+import { OverlayBundle } from '../../types';
+import DisplayAttribute from './DisplayAttribute';
+export default class LocalizedCredential {
+    #private;
+    issuer: string;
+    name: string;
+    attributes: DisplayAttribute[];
+    constructor(bundle: OverlayBundle, record: CredentialExchangeRecord, language: string);
+    get primaryAttribute(): DisplayAttribute | undefined;
+    get secondaryAttribute(): DisplayAttribute | undefined;
+    getAttribute(attributeName?: string): DisplayAttribute | undefined;
+}

package/build/formatters/credential/LocalizedCredential.js

@@ -0,0 +1,57 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _LocalizedCredential_bundle;
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@credo-ts/core");
+const DisplayAttribute_1 = __importDefault(require("./DisplayAttribute"));
+class LocalizedCredential {
+    constructor(bundle, record, language) {
+        var _a, _b, _c, _d;
+        _LocalizedCredential_bundle.set(this, void 0);
+        if (!language) {
+            throw new Error('language is required');
+        }
+        __classPrivateFieldSet(this, _LocalizedCredential_bundle, bundle, "f");
+        this.issuer = (_a = bundle.metadata.issuer) === null || _a === void 0 ? void 0 : _a[language];
+        this.name = (_b = bundle.metadata.name) === null || _b === void 0 ? void 0 : _b[language];
+        // If no record attributes are present then grab default attributes from the bundle
+        const credentialAttributes = ((_c = record.credentialAttributes) === null || _c === void 0 ? void 0 : _c.length)
+            ? record.credentialAttributes
+            : bundle.attributes.map((attribute) => {
+                return new core_1.CredentialPreviewAttribute(Object.assign(Object.assign({}, attribute), { value: '' }));
+            });
+        this.attributes =
+            (_d = credentialAttributes === null || credentialAttributes === void 0 ? void 0 : credentialAttributes.filter((attribute) => bundle.getAttribute(attribute.name)).map((attribute) => new DisplayAttribute_1.default(attribute, { name: attribute.name, type: '' }, language))) !== null && _d !== void 0 ? _d : [];
+    }
+    get primaryAttribute() {
+        var _a;
+        const name = (_a = __classPrivateFieldGet(this, _LocalizedCredential_bundle, "f").branding) === null || _a === void 0 ? void 0 : _a.primaryAttribute;
+        return this.getAttribute(name);
+    }
+    get secondaryAttribute() {
+        var _a;
+        const name = (_a = __classPrivateFieldGet(this, _LocalizedCredential_bundle, "f").branding) === null || _a === void 0 ? void 0 : _a.secondaryAttribute;
+        return this.getAttribute(name);
+    }
+    getAttribute(attributeName) {
+        if (!attributeName) {
+            return undefined;
+        }
+        return this.attributes.find((attribute) => attribute.name === attributeName);
+    }
+}
+_LocalizedCredential_bundle = new WeakMap();
+exports.default = LocalizedCredential;

package/build/formatters/credential/index.d.ts

@@ -0,0 +1,4 @@
+import CredentialFormatter from './CredentialFormatter';
+import DisplayAttribute from './DisplayAttribute';
+import LocalizedCredential from './LocalizedCredential';
+export { CredentialFormatter, DisplayAttribute, LocalizedCredential };

package/build/formatters/credential/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalizedCredential = exports.DisplayAttribute = exports.CredentialFormatter = void 0;
+const CredentialFormatter_1 = __importDefault(require("./CredentialFormatter"));
+exports.CredentialFormatter = CredentialFormatter_1.default;
+const DisplayAttribute_1 = __importDefault(require("./DisplayAttribute"));
+exports.DisplayAttribute = DisplayAttribute_1.default;
+const LocalizedCredential_1 = __importDefault(require("./LocalizedCredential"));
+exports.LocalizedCredential = LocalizedCredential_1.default;

package/build/formatters/index.d.ts

@@ -0,0 +1,4 @@
+import CredentialFormatter from './credential/CredentialFormatter';
+import DisplayAttribute from './credential/DisplayAttribute';
+import LocalizedCredential from './credential/LocalizedCredential';
+export { CredentialFormatter, DisplayAttribute, LocalizedCredential };

package/build/formatters/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalizedCredential = exports.DisplayAttribute = exports.CredentialFormatter = void 0;
+const CredentialFormatter_1 = __importDefault(require("./credential/CredentialFormatter"));
+exports.CredentialFormatter = CredentialFormatter_1.default;
+const DisplayAttribute_1 = __importDefault(require("./credential/DisplayAttribute"));
+exports.DisplayAttribute = DisplayAttribute_1.default;
+const LocalizedCredential_1 = __importDefault(require("./credential/LocalizedCredential"));
+exports.LocalizedCredential = LocalizedCredential_1.default;

package/build/index.d.ts

@@ -0,0 +1,5 @@
+export * from './formatters';
+export * from './interfaces';
+export * from './types';
+export * from './utils';
+export * as legacy from './legacy';

package/build/index.js

@@ -0,0 +1,34 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.legacy = void 0;
+__exportStar(require("./formatters"), exports);
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
+exports.legacy = __importStar(require("./legacy"));

package/build/interfaces/data/base/BaseOverlayData.interface.d.ts

@@ -0,0 +1,5 @@
+export default interface IBaseOverlayData {
+    type: string;
+    capture_base: string;
+    digest?: string;
+}

package/build/interfaces/data/base/BaseOverlayData.interface.js

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

package/build/interfaces/data/branding/BrandingOverlayData.interface.d.ts

@@ -0,0 +1,12 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface IBrandingOverlayData extends IBaseOverlayData {
+    logo?: string;
+    background_image?: string;
+    background_image_slice?: string;
+    primary_background_color?: string;
+    secondary_background_color?: string;
+    primary_attribute?: string;
+    secondary_attribute?: string;
+    issued_date_attribute?: string;
+    expiry_date_attribute?: string;
+}

package/build/interfaces/data/branding/BrandingOverlayData.interface.js

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

package/build/interfaces/data/branding/LegacyBrandingOverlayData.interface.d.ts

@@ -0,0 +1,15 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface ILegacyBrandingOverlayData extends IBaseOverlayData {
+    background_color?: string;
+    image_source?: string;
+    header?: {
+        color?: string;
+        background_color?: string;
+        image_source?: string;
+        hide_issuer?: boolean;
+    };
+    footer?: {
+        color?: string;
+        background_color?: string;
+    };
+}

package/build/interfaces/data/branding/LegacyBrandingOverlayData.interface.js

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

package/build/interfaces/data/bundle/OverlayBundleData.interface.d.ts

@@ -0,0 +1,6 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+import ICaptureBaseData from '../capture-base/CaptureBaseData.interface';
+export default interface IOverlayBundleData {
+    capture_base: ICaptureBaseData;
+    overlays: IBaseOverlayData[];
+}

package/build/interfaces/data/bundle/OverlayBundleData.interface.js

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

package/build/interfaces/data/capture-base/CaptureBaseData.interface.d.ts

@@ -0,0 +1,7 @@
+export default interface ICaptureBaseData {
+    type: string;
+    classification: string;
+    attributes: Record<string, string>;
+    flagged_attributes: string[];
+    digest?: string;
+}

package/build/interfaces/data/capture-base/CaptureBaseData.interface.js

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

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

@@ -0,0 +1,12 @@
+import IBaseOverlayData from './base/BaseOverlayData.interface';
+import IBrandingOverlayData from './branding/BrandingOverlayData.interface';
+import ILegacyBrandingOverlayData from './branding/LegacyBrandingOverlayData.interface';
+import IOverlayBundleData from './bundle/OverlayBundleData.interface';
+import ICaptureBaseData from './capture-base/CaptureBaseData.interface';
+import ICharacterEncodingOverlayData from './semantic/CharacterEncodingOverlayData.interface';
+import IFormatOverlayData from './semantic/FormatOverlayData.interface';
+import IInformationOverlayData from './semantic/InformationOverlayData.interface';
+import ILabelOverlayData from './semantic/LabelOverlayData.interface';
+import IMetaOverlayData from './semantic/MetaOverlayData.interface';
+import IStandardOverlayData from './semantic/StandardOverlayData.interface';
+export { IBaseOverlayData, ICaptureBaseData, IOverlayBundleData, IBrandingOverlayData, ILegacyBrandingOverlayData, ICharacterEncodingOverlayData, IFormatOverlayData, IInformationOverlayData, ILabelOverlayData, IMetaOverlayData, IStandardOverlayData, };

package/build/interfaces/data/index.js

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

package/build/interfaces/data/semantic/CharacterEncodingOverlayData.interface.d.ts

@@ -0,0 +1,6 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface ICharacterEncodingOverlayData extends IBaseOverlayData {
+    default_character_encoding: string;
+    attr_character_encoding: Record<string, string>;
+    attribute_character_encoding: Record<string, string>;
+}

package/build/interfaces/data/semantic/CharacterEncodingOverlayData.interface.js

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

package/build/interfaces/data/semantic/FormatOverlayData.interface.d.ts

@@ -0,0 +1,4 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface IFormatOverlayData extends IBaseOverlayData {
+    attribute_formats: Record<string, string>;
+}

package/build/interfaces/data/semantic/FormatOverlayData.interface.js

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

package/build/interfaces/data/semantic/InformationOverlayData.interface.d.ts

@@ -0,0 +1,5 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface IInformationOverlayData extends IBaseOverlayData {
+    language: string;
+    attribute_information: Record<string, string>;
+}

package/build/interfaces/data/semantic/InformationOverlayData.interface.js

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

package/build/interfaces/data/semantic/LabelOverlayData.interface.d.ts

@@ -0,0 +1,7 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface ILabelOverlayData extends IBaseOverlayData {
+    language: string;
+    attribute_labels: Record<string, string>;
+    attribute_categories: string[];
+    category_labels: Record<string, string>;
+}

package/build/interfaces/data/semantic/LabelOverlayData.interface.js

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

package/build/interfaces/data/semantic/MetaOverlayData.interface.d.ts

@@ -0,0 +1,12 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface IMetaOverlayData extends IBaseOverlayData {
+    language: string;
+    name: string;
+    description: string;
+    credential_help_text: string;
+    credential_support_url: string;
+    issuer: string;
+    issuer_description: string;
+    issuer_url: string;
+    watermark?: string;
+}

package/build/interfaces/data/semantic/MetaOverlayData.interface.js

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

package/build/interfaces/data/semantic/StandardOverlayData.interface.d.ts

@@ -0,0 +1,5 @@
+import IBaseOverlayData from '../base/BaseOverlayData.interface';
+export default interface IStandardOverlayData extends IBaseOverlayData {
+    attr_standards: Record<string, string>;
+    attribute_standards: Record<string, string>;
+}

package/build/interfaces/data/semantic/StandardOverlayData.interface.js

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

package/build/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './data';
+export * from './overlay';