@bifold/oca 1.0.0

package/build/types/semantic/MetaOverlay.js

@@ -0,0 +1,54 @@
+"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 _MetaOverlay_credential_help_text, _MetaOverlay_credential_support_url, _MetaOverlay_issuer_description, _MetaOverlay_issuer_url, _MetaOverlay_watermark;
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseOverlay_1 = __importDefault(require("../base/BaseOverlay"));
+class MetaOverlay extends BaseOverlay_1.default {
+    constructor(overlay) {
+        super(overlay);
+        _MetaOverlay_credential_help_text.set(this, void 0);
+        _MetaOverlay_credential_support_url.set(this, void 0);
+        _MetaOverlay_issuer_description.set(this, void 0);
+        _MetaOverlay_issuer_url.set(this, void 0);
+        _MetaOverlay_watermark.set(this, void 0);
+        this.language = overlay.language;
+        this.name = overlay.name;
+        this.description = overlay.description;
+        __classPrivateFieldSet(this, _MetaOverlay_credential_help_text, overlay.credential_help_text, "f");
+        __classPrivateFieldSet(this, _MetaOverlay_credential_support_url, overlay.credential_support_url, "f");
+        this.issuer = overlay.issuer;
+        __classPrivateFieldSet(this, _MetaOverlay_issuer_description, overlay.issuer_description, "f");
+        __classPrivateFieldSet(this, _MetaOverlay_issuer_url, overlay.issuer_url, "f");
+        __classPrivateFieldSet(this, _MetaOverlay_watermark, overlay.watermark, "f");
+    }
+    get credentialHelpText() {
+        return __classPrivateFieldGet(this, _MetaOverlay_credential_help_text, "f");
+    }
+    get credentialSupportUrl() {
+        return __classPrivateFieldGet(this, _MetaOverlay_credential_support_url, "f");
+    }
+    get issuerDescription() {
+        return __classPrivateFieldGet(this, _MetaOverlay_issuer_description, "f");
+    }
+    get issuerUrl() {
+        return __classPrivateFieldGet(this, _MetaOverlay_issuer_url, "f");
+    }
+    get watermark() {
+        return __classPrivateFieldGet(this, _MetaOverlay_watermark, "f");
+    }
+}
+_MetaOverlay_credential_help_text = new WeakMap(), _MetaOverlay_credential_support_url = new WeakMap(), _MetaOverlay_issuer_description = new WeakMap(), _MetaOverlay_issuer_url = new WeakMap(), _MetaOverlay_watermark = new WeakMap();
+exports.default = MetaOverlay;

package/build/types/semantic/StandardOverlay.d.ts

@@ -0,0 +1,8 @@
+import { IStandardOverlayData } from '../../interfaces/data';
+import BaseOverlay from '../base/BaseOverlay';
+export default class StandardOverlay extends BaseOverlay {
+    #private;
+    constructor(overlay: IStandardOverlayData);
+    get attrStandards(): Record<string, string> | undefined;
+    get attributeStandards(): Record<string, string>;
+}

package/build/types/semantic/StandardOverlay.js

@@ -0,0 +1,38 @@
+"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 _StandardOverlay_attr_standards, _StandardOverlay_attribute_standards;
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseOverlay_1 = __importDefault(require("../base/BaseOverlay"));
+class StandardOverlay extends BaseOverlay_1.default {
+    constructor(overlay) {
+        super(overlay);
+        // DEPRECATED - Use #attribute_standards instead
+        _StandardOverlay_attr_standards.set(this, void 0);
+        _StandardOverlay_attribute_standards.set(this, void 0);
+        // DEPRECATED - Use #attribute_standards instead
+        __classPrivateFieldSet(this, _StandardOverlay_attr_standards, overlay.attr_standards, "f");
+        __classPrivateFieldSet(this, _StandardOverlay_attribute_standards, overlay.attribute_standards, "f");
+    }
+    // DEPRECATED - Use attributeStandards instead
+    get attrStandards() {
+        return __classPrivateFieldGet(this, _StandardOverlay_attr_standards, "f");
+    }
+    get attributeStandards() {
+        return __classPrivateFieldGet(this, _StandardOverlay_attribute_standards, "f");
+    }
+}
+_StandardOverlay_attr_standards = new WeakMap(), _StandardOverlay_attribute_standards = new WeakMap();
+exports.default = StandardOverlay;

package/build/utils/color/generateColor.d.ts

@@ -0,0 +1,2 @@
+declare const generateColor: (seed: string) => string;
+export default generateColor;

package/build/utils/color/generateColor.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const hashCode_1 = __importDefault(require("./hashCode"));
+const hashToRGBA_1 = __importDefault(require("./hashToRGBA"));
+const generateColor = (seed) => {
+    return (0, hashToRGBA_1.default)((0, hashCode_1.default)(seed));
+};
+exports.default = generateColor;

package/build/utils/color/hashCode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a numerical hash based on a given string
+ * @see https://stackoverflow.com/questions/3426404/create-a-hexadecimal-colour-based-on-a-string-with-javascript
+ * @param { string } s given string
+ * @returns { number } numerical hash value
+ */
+declare const hashCode: (s: string) => number;
+export default hashCode;

package/build/utils/color/hashCode.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Generates a numerical hash based on a given string
+ * @see https://stackoverflow.com/questions/3426404/create-a-hexadecimal-colour-based-on-a-string-with-javascript
+ * @param { string } s given string
+ * @returns { number } numerical hash value
+ */
+const hashCode = (s) => {
+    return s.split('').reduce((hash, char) => char.charCodeAt(0) + ((hash << 5) - hash), 0);
+};
+exports.default = hashCode;

package/build/utils/color/hashToRGBA.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a numerical hash into a hexidecimal color string
+ * @see https://helderesteves.com/generating-random-colors-js/#Generating_random_dark_colors
+ * @param { number } hash numerical hash value (generated by hashCode function above)
+ * @returns { string } hexidecimal string eg. #32d3cc
+ */
+declare const hashToRGBA: (hash: number) => string;
+export default hashToRGBA;

package/build/utils/color/hashToRGBA.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mulberry32_1 = __importDefault(require("./mulberry32"));
+/**
+ * Converts a numerical hash into a hexidecimal color string
+ * @see https://helderesteves.com/generating-random-colors-js/#Generating_random_dark_colors
+ * @param { number } hash numerical hash value (generated by hashCode function above)
+ * @returns { string } hexidecimal string eg. #32d3cc
+ */
+const hashToRGBA = (hash) => {
+    let color = '#';
+    const colorRangeUpperBound = 256;
+    // once for r, g, b
+    for (let i = 0; i < 3; i++) {
+        // append a pseudorandom two-char hexidecimal value from the lower half of the color spectrum (to limit to darker colors)
+        color += ('0' + Math.floor(((0, mulberry32_1.default)(hash + i) * colorRangeUpperBound) / 2).toString(16)).slice(-2);
+    }
+    return color;
+};
+exports.default = hashToRGBA;

package/build/utils/color/index.d.ts

@@ -0,0 +1,5 @@
+import generateColor from './generateColor';
+import hashCode from './hashCode';
+import hashToRGBA from './hashToRGBA';
+import { textColorForBackground } from './textColorForBackground';
+export { generateColor, textColorForBackground, hashCode, hashToRGBA };

package/build/utils/color/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hashToRGBA = exports.hashCode = exports.textColorForBackground = exports.generateColor = void 0;
+const generateColor_1 = __importDefault(require("./generateColor"));
+exports.generateColor = generateColor_1.default;
+// Remove hashCode and hashToRGBA when deprecated OCA resolver is removed
+const hashCode_1 = __importDefault(require("./hashCode"));
+exports.hashCode = hashCode_1.default;
+const hashToRGBA_1 = __importDefault(require("./hashToRGBA"));
+exports.hashToRGBA = hashToRGBA_1.default;
+const textColorForBackground_1 = require("./textColorForBackground");
+Object.defineProperty(exports, "textColorForBackground", { enumerable: true, get: function () { return textColorForBackground_1.textColorForBackground; } });

package/build/utils/color/luminanceForHexColor.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts a hexidecimal color string into a luminance value
+ * @param hex color string in hexidecimal format
+ * @returns { number | undefined } between 0 and 255
+ */
+declare const luminanceForHexColor: (hex: string) => number | undefined;
+export default luminanceForHexColor;

package/build/utils/color/luminanceForHexColor.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Converts a hexidecimal color string into a luminance value
+ * @param hex color string in hexidecimal format
+ * @returns { number | undefined } between 0 and 255
+ */
+const luminanceForHexColor = (hex) => {
+    if (!/^#([A-Fa-f0-9]{6})$/.test(hex)) {
+        return;
+    }
+    const hexAsNumber = Number(`0x${hex.slice(1)}`);
+    const [r, g, b] = [(hexAsNumber >> 16) & 255, (hexAsNumber >> 8) & 255, hexAsNumber & 255];
+    // Scalars below defined [here](https://en.wikipedia.org/wiki/Relative_luminance)
+    const y = 0.2126 * r + 0.7152 * g + 0.0722 * b;
+    return Math.round(y);
+};
+exports.default = luminanceForHexColor;

package/build/utils/color/mulberry32.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generates a pseudorandom number between 0 and 1 based on a seed
+ * @see https://gist.github.com/tommyettinger/46a874533244883189143505d203312c
+ * @see https://stackoverflow.com/questions/521295/seeding-the-random-number-generator-in-javascript
+ * @param { number } seed any number
+ * @returns { number } pseudorandom number between 0 and 1
+ */
+declare const mulberry32: (seed: number) => number;
+export default mulberry32;

package/build/utils/color/mulberry32.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Generates a pseudorandom number between 0 and 1 based on a seed
+ * @see https://gist.github.com/tommyettinger/46a874533244883189143505d203312c
+ * @see https://stackoverflow.com/questions/521295/seeding-the-random-number-generator-in-javascript
+ * @param { number } seed any number
+ * @returns { number } pseudorandom number between 0 and 1
+ */
+const mulberry32 = (seed) => {
+    let t = (seed += 0x6d2b79f5);
+    t = Math.imul(t ^ (t >>> 15), t | 1);
+    t ^= t + Math.imul(t ^ (t >>> 7), t | 61);
+    return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
+};
+exports.default = mulberry32;

package/build/utils/color/textColorForBackground.d.ts

@@ -0,0 +1 @@
+export declare const textColorForBackground: (background: string) => string;

package/build/utils/color/textColorForBackground.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.textColorForBackground = void 0;
+const luminanceForHexColor_1 = __importDefault(require("./luminanceForHexColor"));
+const textColorForBackground = (background) => {
+    var _a;
+    const spectrum = {
+        black: '#000000',
+        darkGrey: '#313132',
+        mediumGrey: '#606060',
+        lightGrey: '#D3D3D3',
+        veryLightGrey: '#F2F2F2',
+        white: '#FFFFFF',
+    };
+    const midpoint = 255 / 2;
+    if (((_a = (0, luminanceForHexColor_1.default)(background !== null && background !== void 0 ? background : '')) !== null && _a !== void 0 ? _a : 0) >= midpoint) {
+        return spectrum.darkGrey;
+    }
+    return spectrum.white;
+};
+exports.textColorForBackground = textColorForBackground;

package/build/utils/credential-definition.d.ts

@@ -0,0 +1 @@
+export declare function parseCredDefFromId(credDefId?: string, schemaId?: string): string;

package/build/utils/credential-definition.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseCredDefFromId = parseCredDefFromId;
+const schema_1 = require("./schema");
+function parseCredDefFromId(credDefId, schemaId) {
+    let name = 'Credential';
+    if (credDefId) {
+        const credDefRegex = /[^:]+/g;
+        const credDefIdParts = credDefId.match(credDefRegex);
+        if ((credDefIdParts === null || credDefIdParts === void 0 ? void 0 : credDefIdParts.length) === 5) {
+            name = `${credDefIdParts === null || credDefIdParts === void 0 ? void 0 : credDefIdParts[4].replace(/_|-/g, ' ')}`
+                .split(' ')
+                .map((credIdPart) => credIdPart.charAt(0).toUpperCase() + credIdPart.substring(1))
+                .join(' ');
+        }
+    }
+    if (name.toLocaleLowerCase() === 'default' || name.toLowerCase() === 'credential') {
+        name = (0, schema_1.parseSchemaFromId)(schemaId).name;
+    }
+    return name;
+}

package/build/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './color';

package/build/utils/index.js

@@ -0,0 +1,17 @@
+"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("./color"), exports);

package/build/utils/logger.d.ts

@@ -0,0 +1,5 @@
+export default class MiniLogger {
+    warn(message: string): void;
+    error(message: string): void;
+    info(message: string): void;
+}

package/build/utils/logger.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class MiniLogger {
+    warn(message) {
+        // eslint-disable-next-line no-console
+        console.log(message);
+    }
+    error(message) {
+        // eslint-disable-next-line no-console
+        console.log(message);
+    }
+    info(message) {
+        // eslint-disable-next-line no-console
+        console.log(message);
+    }
+}
+exports.default = MiniLogger;

package/build/utils/schema.d.ts

@@ -0,0 +1,4 @@
+export declare function parseSchemaFromId(schemaId?: string): {
+    name: string;
+    version: string;
+};

package/build/utils/schema.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSchemaFromId = parseSchemaFromId;
+function parseSchemaFromId(schemaId) {
+    let name = 'Credential';
+    let version = '';
+    if (schemaId) {
+        const schemaIdRegex = /(.*?):([0-9]):([a-zA-Z .\-_0-9]+):([a-z0-9._-]+)$/;
+        const schemaIdParts = schemaId.match(schemaIdRegex);
+        if ((schemaIdParts === null || schemaIdParts === void 0 ? void 0 : schemaIdParts.length) === 5) {
+            name = `${schemaIdParts === null || schemaIdParts === void 0 ? void 0 : schemaIdParts[3].replace(/_|-/g, ' ')}`
+                .split(' ')
+                .map((schemaIdPart) => schemaIdPart.charAt(0).toUpperCase() + schemaIdPart.substring(1))
+                .join(' ');
+            version = schemaIdParts === null || schemaIdParts === void 0 ? void 0 : schemaIdParts[4];
+        }
+    }
+    return { name, version };
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@bifold/oca",
+  "version": "1.0.0",
+  "description": "TypeScript implementation of Overlay Capture Architecture (OCA) for styling Aries Verifiable Credentials",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "source": "src/index.ts",
+  "files": [
+    "src",
+    "build"
+  ],
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "echo 'building oca 🏗️' && yarn run clean && yarn run compile && echo 'oca built ✅'",
+    "clean": "rimraf ./build",
+    "compile": "tsc",
+    "test": "TZ=GMT jest --config ./jest.config.js",
+    "test:watch": "TZ=GMT jest --config ./jest.config.js --watch",
+    "coverage": "TZ=GMT jest --config ./jest.config.js --coverage"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openwallet-foundation/bifold-wallet.git",
+    "directory": "packages/oca"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/openwallet-foundation/bifold-wallet/issues"
+  },
+  "homepage": "https://github.com/openwallet-foundation/bifold-wallet/",
+  "devDependencies": {
+    "@testing-library/jest-native": "5.4.3",
+    "@types/jest": "29.5.5",
+    "@types/lodash.startcase": "^4.4.7",
+    "@typescript-eslint/parser": "^6.6.0",
+    "eslint": "^8.48.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "jest": "29.6.4",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "@credo-ts/anoncreds": "0.5.13",
+    "@credo-ts/core": "0.5.13",
+    "axios": "^1.4.0",
+    "lodash.startcase": "^4.4.0",
+    "react-native-fs": "^2.16.6"
+  }
+}