@uzum-tech/design-tokens-resolver 0.0.0-stage → 1.0.0

package/lib/mappers/cli.mapper.d.ts

@@ -0,0 +1,7 @@
+import { ConfigTypes } from '../types/config.types';
+import { ResolveTypes } from '../types/resolve.types';
+export default class CliMapper {
+    static toConfig(args: Record<string, string | boolean>, file: ConfigTypes.FileConfig): ConfigTypes.Config;
+    static toRequest(args: Record<string, string | boolean>, file: ConfigTypes.FileConfig): ResolveTypes.Request;
+    private static toAuth;
+}

package/lib/mappers/document.mapper.d.ts

@@ -0,0 +1,12 @@
+import { DocumentTypes } from '../types/document.types';
+import { ResolveTypes } from '../types/resolve.types';
+export default class DocumentMapper {
+    static toJson(canonical: string, query: ResolveTypes.Query): string;
+    static toOutput(document: DocumentTypes.Document, query: ResolveTypes.Query): DocumentTypes.Output;
+    private static isCanonical;
+    private static toFlatDocument;
+    private static toTokens;
+    private static toDtcg;
+    private static groupByMode;
+    private static toTree;
+}

package/lib/mappers/lock.mapper.d.ts

@@ -0,0 +1,6 @@
+import { ReleaseTypes } from '../types/release.types';
+import { ResolveTypes } from '../types/resolve.types';
+export default class LockMapper {
+    static toLock(release: ReleaseTypes.Release, source: ResolveTypes.Source): ResolveTypes.Lock;
+    static toJson(lock: ResolveTypes.Lock): string;
+}

package/lib/mappers/resolve.mapper.d.ts

@@ -0,0 +1,6 @@
+import { DocumentTypes } from '../types/document.types';
+export default class ResolveMapper {
+    static toScope(document: DocumentTypes.Document): DocumentTypes.ResolveScope;
+    static toLiteralKey(collection: string, mode: string, path: string): string;
+    static toTarget(alias: string, state: DocumentTypes.ResolveState): DocumentTypes.ResolveTarget | null;
+}

package/lib/types/config.types.d.ts

@@ -0,0 +1,50 @@
+export declare namespace ConfigTypes {
+    enum Format {
+        FLAT = "FLAT",
+        DTCG = "DTCG"
+    }
+    enum Env {
+        LOCAL = "local",
+        DEVELOPMENT = "development",
+        PRODUCTION = "production"
+    }
+    interface Auth {
+        username: string;
+        password: string;
+    }
+    interface FileConfig {
+        env?: Env;
+        baseUrl?: string;
+        auth?: Auth;
+        apiKey?: string;
+        requestTimeoutInMs?: number;
+        retryCount?: number;
+        retryDelayInMs?: number;
+        collection?: string;
+        outputPath?: string;
+        fileName?: string;
+        channel?: string;
+    }
+    interface Config {
+        env?: Env;
+        baseUrl?: string;
+        auth?: Auth;
+        apiKey?: string;
+        requestTimeoutInMs?: number;
+        retryCount?: number;
+        retryDelayInMs?: number;
+    }
+    interface Resolved {
+        baseUrl: string;
+        auth: Auth | null;
+        apiKey: string | null;
+        requestTimeoutInMs: number;
+        retryCount: number;
+        retryDelayInMs: number;
+    }
+    interface LoadedFile {
+        path: string;
+        config: FileConfig;
+    }
+    type FileExport = FileConfig | (() => FileConfig) | (() => Promise<FileConfig>);
+}

package/lib/types/document.types.d.ts

@@ -0,0 +1,65 @@
+export declare namespace DocumentTypes {
+    interface RawValueObject {
+        [key: string]: RawValue;
+    }
+    interface Mode {
+        slug: string;
+        name: string;
+        brand: string | null;
+        theme: string | null;
+        isDefault: boolean;
+    }
+    interface Collection {
+        slug: string;
+        name: string;
+        description: string | null;
+        layout: string;
+        modes: Mode[];
+    }
+    interface Token {
+        collection: string;
+        mode: string;
+        path: string;
+        $type: string;
+        $value: RawValue;
+    }
+    interface Document {
+        schemaVersion: number;
+        collections: Collection[];
+        tokens: Token[];
+    }
+    interface DtcgNode {
+        $type: string;
+        $value: RawValue;
+    }
+    interface DtcgEntry {
+        path: string;
+        node: DtcgNode;
+    }
+    interface DtcgGroup {
+        [key: string]: DtcgGroup | DtcgNode;
+    }
+    interface CollectionModes {
+        slugs: Set<string>;
+        defaultSlug: string;
+    }
+    interface ResolveScope {
+        literals: Record<string, RawValue>;
+        modes: Record<string, CollectionModes>;
+    }
+    interface ResolvePoint {
+        collection: string;
+        mode: string;
+    }
+    interface ResolveState {
+        scope: ResolveScope;
+        point: ResolvePoint;
+        depth: number;
+    }
+    interface ResolveTarget {
+        path: string;
+        point: ResolvePoint;
+    }
+    type RawValue = string | number | boolean | RawValueObject | RawValue[] | null;
+    type Output = Document | DtcgGroup;
+}

package/lib/types/error.types.d.ts

@@ -0,0 +1,17 @@
+import { HttpTypes } from './http.types';
+export declare namespace ErrorTypes {
+    enum Code {
+        CONFIG_INVALID = "CONFIG_INVALID",
+        REQUEST_FAILED = "REQUEST_FAILED",
+        RELEASE_NOT_FOUND = "RELEASE_NOT_FOUND",
+        CHANNEL_EMPTY = "CHANNEL_EMPTY",
+        INTEGRITY_MISMATCH = "INTEGRITY_MISMATCH",
+        WRITE_FAILED = "WRITE_FAILED"
+    }
+    interface Options {
+        code: Code;
+        cause?: unknown;
+        statusCode?: HttpTypes.Status;
+        body?: unknown;
+    }
+}

package/lib/types/http.types.d.ts

@@ -0,0 +1,8 @@
+export declare namespace HttpTypes {
+    enum Status {
+        UNAUTHORIZED = 401,
+        NOT_FOUND = 404,
+        TOO_MANY_REQUESTS = 429,
+        INTERNAL_SERVER_ERROR = 500
+    }
+}

package/lib/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './config.types';
+export * from './document.types';
+export * from './error.types';
+export * from './http.types';
+export * from './release.types';
+export * from './resolve.types';

package/lib/types/release.types.d.ts

@@ -0,0 +1,31 @@
+export declare namespace ReleaseTypes {
+    interface Stats {
+        collections: number;
+        modes: number;
+        tokens: number;
+        values: number;
+    }
+    interface Release {
+        version: string;
+        status: string;
+        contentHash: string;
+        parentVersion: string | null;
+        stats: Stats | null;
+        byteSize: number | null;
+        notes: string | null;
+        sourceLabel: string | null;
+        publishedBy: string | null;
+        createdAt: string;
+    }
+    interface Payload {
+        version: string;
+        document: string;
+        contentHash: string;
+    }
+    interface Channel {
+        slug: string;
+        name: string;
+        version: string | null;
+        locked: boolean | null;
+    }
+}

package/lib/types/resolve.types.d.ts

@@ -0,0 +1,41 @@
+import { ConfigTypes } from './config.types';
+import { ReleaseTypes } from './release.types';
+export declare namespace ResolveTypes {
+    interface Query {
+        collection?: string;
+        format?: ConfigTypes.Format;
+        resolve?: boolean;
+    }
+    interface Target extends Query {
+        version?: string;
+        channel?: string;
+    }
+    interface Request extends Target {
+        outputPath: string;
+        fileName?: string;
+        lock?: boolean;
+    }
+    interface Verified {
+        release: ReleaseTypes.Release;
+        body: string;
+    }
+    interface Source {
+        baseUrl: string;
+    }
+    interface Lock {
+        version: string;
+        contentHash: string;
+        baseUrl: string;
+        byteSize: number | null;
+        publishedAt: string;
+        publishedBy: string | null;
+        sourceLabel: string | null;
+    }
+    interface Result {
+        release: ReleaseTypes.Release;
+        source: Source;
+        tokensPath: string;
+        lockPath: string | null;
+        bytesWritten: number;
+    }
+}

package/lib/utils/args.utils.d.ts

@@ -0,0 +1,9 @@
+import { ConfigTypes } from '../types/config.types';
+export default class ArgsUtils {
+    static parse(args: string[]): Record<string, string | boolean>;
+    static toFormat(value?: string | boolean): ConfigTypes.Format | undefined;
+    static toEnv(value?: string | boolean): ConfigTypes.Env | undefined;
+    static toText(value?: string | boolean): string | undefined;
+    private static toNormalized;
+    private static toKey;
+}

package/lib/utils/file.utils.d.ts

@@ -0,0 +1,3 @@
+export default class FileUtils {
+    static write(outputPath: string, fileName: string, body: string): string;
+}

package/lib/utils/hash.utils.d.ts

@@ -0,0 +1,3 @@
+export default class HashUtils {
+    static toContentHash(body: string): string;
+}

package/lib/utils/resolve.utils.d.ts

@@ -0,0 +1,6 @@
+import { DocumentTypes } from '../types/document.types';
+export default class ResolveUtils {
+    static resolve(value: DocumentTypes.RawValue, state: DocumentTypes.ResolveState): DocumentTypes.RawValue;
+    private static parseAlias;
+    private static resolveAlias;
+}

package/lib/utils/url.utils.d.ts

@@ -0,0 +1,4 @@
+export default class UrlUtils {
+    static join(...parts: string[]): string;
+    static toQuery(params: Record<string, string | boolean | undefined>): string;
+}

package/package.json

@@ -1,6 +1,80 @@
 {
   "name": "@uzum-tech/design-tokens-resolver",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Fetches published design tokens from the design tokens service by version or channel, verifies content integrity and writes them to disk",
+  "type": "commonjs",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.mjs",
+  "types": "./lib/index.d.ts",
+  "bin": {
+    "design-tokens-resolver": "./lib/cli.cjs"
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.cjs",
+      "default": "./lib/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20.18.1"
+  },
+  "packageManager": "pnpm@10.9.0",
+  "scripts": {
+    "clean": "node -e \"require('fs').rmSync('lib',{recursive:true,force:true})\"",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build:js": "node esbuild.config.mjs",
+    "build": "pnpm clean && pnpm build:types && pnpm build:js",
+    "prepare": "husky install",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "pnpm lint --fix",
+    "test:build": "node esbuild.config.mjs --out-dir .test-build",
+    "test": "pnpm test:build && node --test \"tests/**/*.test.mjs\"",
+    "prepack": "npm login && pnpm i && pnpm build",
+    "test:watch": "pnpm test:build && node --test --watch \"tests/**/*.test.mjs\"",
+    "precommit": "concurrently --kill-others-on-fail \"pnpm typecheck\" \"lint-staged\" \"pnpm test\""
+  },
+  "keywords": [
+    "uzum",
+    "design-tokens",
+    "dtcg",
+    "figma",
+    "cli"
+  ],
+  "author": {
+    "name": "KapitalLab"
+  },
+  "contributors": [
+    {
+      "name": "Mardonov Baxtiyor",
+      "email": "jbalancer@mail.ru",
+      "url": "https://jbalancer.com"
+    }
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "20.11.5",
+    "@uzum-tech/eslint": "1.1.2",
+    "esbuild": "0.27.2",
+    "typescript": "5.7.3",
+    "concurrently": "9.1.2",
+    "lint-staged": "15.3.0",
+    "husky": "8.0.0"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild"
+    ],
+    "overrides": {
+      "putout": "42.5.1",
+      "@putout/processor-toml": "1.1.20"
+    }
+  }
+}