@koralabs/kora-labs-common 2.2.0 → 2.3.0

package/lib/handles/buildMetadata.d.ts

@@ -0,0 +1,6 @@
+import { IHandleMetadata } from './interfaces';
+export declare const buildMetadata: ({ handleName, cid, ogNumber }: {
+    handleName: string;
+    cid: string;
+    ogNumber?: number | undefined;
+}) => IHandleMetadata;

package/lib/handles/buildMetadata.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildMetadata = void 0;
+const interfaces_1 = require("./interfaces");
+const utils_1 = require("./utils");
+const buildCharacters = (name) => {
+    const characters = [];
+    if (/[a-z]+/.test(name)) {
+        characters.push('letters');
+    }
+    if (/[0-9]+/.test(name)) {
+        characters.push('numbers');
+    }
+    if (/[_\-.]+/.test(name)) {
+        characters.push('special');
+    }
+    return characters.join(',');
+};
+const buildNumericModifiers = (name) => {
+    const modifiers = [];
+    if (/^-?[0-9]\d*(\.\d+)?$/.test(name)) {
+        if (name.startsWith('-')) {
+            modifiers.push('negative');
+        }
+        if (name.includes('.')) {
+            modifiers.push('decimal');
+        }
+    }
+    return modifiers.join(',');
+};
+const buildMetadata = ({ handleName, cid, ogNumber }) => {
+    const isSubHandle = handleName.includes('@');
+    const [subHandleName, rootHandleName] = handleName.split('@');
+    let metadata = {
+        name: `$${handleName}`,
+        image: `ipfs://${cid}`,
+        mediaType: 'image/jpeg',
+        og: isSubHandle ? 0 : ogNumber ? 1 : 0,
+        og_number: isSubHandle ? 0 : ogNumber !== null && ogNumber !== void 0 ? ogNumber : 0,
+        rarity: (0, utils_1.getRarity)(rootHandleName !== null && rootHandleName !== void 0 ? rootHandleName : handleName),
+        length: handleName.length,
+        characters: buildCharacters(rootHandleName !== null && rootHandleName !== void 0 ? rootHandleName : handleName),
+        numeric_modifiers: buildNumericModifiers(rootHandleName !== null && rootHandleName !== void 0 ? rootHandleName : handleName),
+        handle_type: isSubHandle ? interfaces_1.HandleType.NFT_SUBHANDLE : interfaces_1.HandleType.HANDLE,
+        version: 1
+    };
+    if (isSubHandle) {
+        metadata = Object.assign(Object.assign({}, metadata), { sub_rarity: (0, utils_1.getRarity)(subHandleName), sub_length: subHandleName.length, sub_characters: buildCharacters(subHandleName), sub_numeric_modifiers: buildNumericModifiers(subHandleName) });
+    }
+    return metadata;
+};
+exports.buildMetadata = buildMetadata;

package/lib/handles/buildMetadata.test.d.ts

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

package/lib/handles/buildMetadata.test.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const buildMetadata_1 = require("./buildMetadata");
+const interfaces_1 = require("./interfaces");
+describe('buildMetadata', () => {
+    it('should build metadata', () => {
+        const input = {
+            handleName: 'test',
+            cid: 'cid123',
+            ogNumber: 1
+        };
+        const metadata = (0, buildMetadata_1.buildMetadata)(input);
+        expect(metadata).toEqual({
+            characters: 'letters',
+            handle_type: interfaces_1.HandleType.HANDLE,
+            image: `ipfs://${input.cid}`,
+            length: 4,
+            mediaType: 'image/jpeg',
+            name: '$' + input.handleName,
+            numeric_modifiers: '',
+            og: input.ogNumber ? 1 : 0,
+            og_number: input.ogNumber,
+            rarity: 'common',
+            version: 1
+        });
+    });
+    it('should build metadata for nft sub handle', () => {
+        const input = {
+            handleName: 'sub@handle',
+            cid: 'cid111'
+        };
+        const metadata = (0, buildMetadata_1.buildMetadata)(input);
+        expect(metadata).toEqual({
+            characters: 'letters',
+            handle_type: interfaces_1.HandleType.NFT_SUBHANDLE,
+            image: `ipfs://${input.cid}`,
+            length: 10,
+            mediaType: 'image/jpeg',
+            name: '$' + input.handleName,
+            numeric_modifiers: '',
+            og: 0,
+            og_number: 0,
+            rarity: 'common',
+            version: 1,
+            sub_characters: 'letters',
+            sub_length: 3,
+            sub_numeric_modifiers: '',
+            sub_rarity: interfaces_1.Rarity.rare
+        });
+    });
+    it('should build metadata for nft sub handle with numbers', () => {
+        const input = {
+            handleName: '...@-123',
+            cid: 'cid222'
+        };
+        const metadata = (0, buildMetadata_1.buildMetadata)(input);
+        expect(metadata).toEqual({
+            characters: 'numbers,special',
+            handle_type: interfaces_1.HandleType.NFT_SUBHANDLE,
+            image: `ipfs://${input.cid}`,
+            length: 8,
+            mediaType: 'image/jpeg',
+            name: '$' + input.handleName,
+            numeric_modifiers: 'negative',
+            og: 0,
+            og_number: 0,
+            rarity: 'common',
+            version: 1,
+            sub_characters: 'special',
+            sub_length: 3,
+            sub_numeric_modifiers: '',
+            sub_rarity: interfaces_1.Rarity.rare
+        });
+    });
+});

package/lib/handles/utils.d.ts

@@ -0,0 +1,2 @@
+import { Rarity } from './interfaces';
+export declare const getRarity: (name: string) => Rarity;

package/lib/handles/utils.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRarity = void 0;
+const interfaces_1 = require("./interfaces");
+const getRarity = (name) => {
+    const length = name.length;
+    if (1 === length) {
+        return interfaces_1.Rarity.legendary;
+    }
+    if (2 === length) {
+        return interfaces_1.Rarity.ultra_rare;
+    }
+    if (3 === length) {
+        return interfaces_1.Rarity.rare;
+    }
+    if (length > 3 && length < 8) {
+        return interfaces_1.Rarity.common;
+    }
+    return interfaces_1.Rarity.basic;
+};
+exports.getRarity = getRarity;

package/lib/handles/validation.js

@@ -10,7 +10,7 @@ const checkHandlePattern = (handle, root) => {
             message: constants_1.RESPONSE_UNAVAILABLE_LEGENDARY
         };
     }
-    if (!handle.match(constants_1.REGEX_SUB_HANDLE) && root ? handle.endsWith(`@${root}`) : true) {
+    if (!handle.match(constants_1.REGEX_SUB_HANDLE) && (root ? handle.endsWith(`@${root}`) : true)) {
         return {
             valid: false,
             message: constants_1.RESPONSE_INVALID_HANDLE_FORMAT

package/lib/handles/validation.test.d.ts

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

package/lib/handles/validation.test.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validation_1 = require("./validation");
+describe('validation tests', () => {
+    it('should return true', () => {
+        const result = (0, validation_1.checkHandlePattern)('...');
+        expect(result).toEqual({ message: 'Yay! This handle is available.', valid: true });
+    });
+    it('should return false', () => {
+        const result = (0, validation_1.checkHandlePattern)('***');
+        expect(result).toEqual({
+            message: 'Invalid handle. Only a-z, 0-9, dash (-), underscore (_), and period (.) are allowed.',
+            valid: false
+        });
+    });
+});

package/lib/index.d.ts

@@ -1,7 +1,9 @@
-export { Logger, LogCategory } from "./logger";
-export { Environment, ComputeEnvironment } from "./environment";
-export * from "./handles/interfaces";
-export * from "./handles/constants";
-export { checkHandlePattern } from "./handles/validation";
-export * from "./utils";
-export { ProtectedWords } from "./protectedWords";
+export { Logger, LogCategory } from './logger';
+export { Environment, ComputeEnvironment } from './environment';
+export * from './handles/interfaces';
+export * from './handles/constants';
+export { checkHandlePattern } from './handles/validation';
+export * from './utils';
+export { ProtectedWords } from './protectedWords';
+export { buildMetadata } from './handles/buildMetadata';
+export * from './handles/utils';

package/lib/index.js

@@ -14,7 +14,7 @@ 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 });
-exports.ProtectedWords = exports.checkHandlePattern = exports.ComputeEnvironment = exports.Environment = exports.LogCategory = exports.Logger = void 0;
+exports.buildMetadata = exports.ProtectedWords = exports.checkHandlePattern = exports.ComputeEnvironment = exports.Environment = exports.LogCategory = exports.Logger = void 0;
 var logger_1 = require("./logger");
 Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_1.Logger; } });
 Object.defineProperty(exports, "LogCategory", { enumerable: true, get: function () { return logger_1.LogCategory; } });
@@ -28,3 +28,6 @@ Object.defineProperty(exports, "checkHandlePattern", { enumerable: true, get: fu
 __exportStar(require("./utils"), exports);
 var protectedWords_1 = require("./protectedWords");
 Object.defineProperty(exports, "ProtectedWords", { enumerable: true, get: function () { return protectedWords_1.ProtectedWords; } });
+var buildMetadata_1 = require("./handles/buildMetadata");
+Object.defineProperty(exports, "buildMetadata", { enumerable: true, get: function () { return buildMetadata_1.buildMetadata; } });
+__exportStar(require("./handles/utils"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koralabs/kora-labs-common",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Kora Labs Common Utilities",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",