pika-shared 1.0.2 → 1.2.0

package/dist/util/server-client-utils.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/util/server-client-utils.ts"],"names":[],"mappings":";AAUA,SAAS,UAAA,CAAW,MAAW,kBAA4C,EAAA;AACvE,EAAA,IAAI,CAAC,IAAA,IAAQ,OAAO,IAAA,KAAS,QAAU,EAAA;AACnC,IAAO,OAAA,IAAA;AAAA;AAGX,EAAA,MAAM,aAAa,KAAM,CAAA,OAAA,CAAQ,kBAAkB,CAAI,GAAA,kBAAA,GAAqB,CAAC,kBAAkB,CAAA;AAC/F,EAAM,MAAA,QAAA,GAAW,EAAE,GAAG,IAAK,EAAA;AAE3B,EAAA,KAAA,MAAW,QAAQ,UAAY,EAAA;AAC3B,IAAA,IAAI,QAAQ,QAAU,EAAA;AAClB,MAAA,QAAA,CAAS,IAAI,CAAA,GAAI,WAAY,CAAA,QAAA,CAAS,IAAI,CAAC,CAAA;AAAA;AAC/C;AAGJ,EAAO,OAAA,QAAA;AACX;AAOA,SAAS,YAAY,KAAiB,EAAA;AAClC,EAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC3B,IAAO,OAAA,YAAA;AAAA,GACA,MAAA,IAAA,KAAA,CAAM,OAAQ,CAAA,KAAK,CAAG,EAAA;AAC7B,IAAA,OAAO,MAAM,GAAI,CAAA,CAAC,IAAS,KAAA,WAAA,CAAY,IAAI,CAAC,CAAA;AAAA,GACrC,MAAA,IAAA,KAAA,IAAS,OAAO,KAAA,KAAU,QAAU,EAAA;AAC3C,IAAA,MAAM,cAAmB,EAAC;AAC1B,IAAA,KAAA,MAAW,OAAO,KAAO,EAAA;AACrB,MAAI,IAAA,KAAA,CAAM,cAAe,CAAA,GAAG,CAAG,EAAA;AAC3B,QAAA,WAAA,CAAY,GAAG,CAAA,GAAI,WAAY,CAAA,KAAA,CAAM,GAAG,CAAC,CAAA;AAAA;AAC7C;AAEJ,IAAO,OAAA,WAAA;AAAA;AAEX,EAAO,OAAA,KAAA;AACX","file":"server-client-utils.mjs","sourcesContent":["/*\n * These are utils that are safe to use both on the server and the client.\n */\n\n/**\n * Helper function to redact sensitive data from specified attributes\n * @param data - The object containing data to redact\n * @param attributesToRedact - Single attribute name or array of attribute names to redact\n * @returns A new object with specified attributes redacted\n */\nfunction redactData(data: any, attributesToRedact: string | string[]): any {\n    if (!data || typeof data !== 'object') {\n        return data;\n    }\n\n    const attributes = Array.isArray(attributesToRedact) ? attributesToRedact : [attributesToRedact];\n    const redacted = { ...data };\n\n    for (const attr of attributes) {\n        if (attr in redacted) {\n            redacted[attr] = redactValue(redacted[attr]);\n        }\n    }\n\n    return redacted;\n}\n\n/**\n * Recursively redacts a value based on its type\n * @param value - The value to redact\n * @returns The redacted value\n */\nfunction redactValue(value: any): any {\n    if (typeof value === 'string') {\n        return '[REDACTED]';\n    } else if (Array.isArray(value)) {\n        return value.map((item) => redactValue(item));\n    } else if (value && typeof value === 'object') {\n        const redactedObj: any = {};\n        for (const key in value) {\n            if (value.hasOwnProperty(key)) {\n                redactedObj[key] = redactValue(value[key]);\n            }\n        }\n        return redactedObj;\n    }\n    return value; // Return as-is for other types (numbers, booleans, null, etc.)\n}\n\n// Export both functions\nexport { redactData, redactValue };\n"]}
+{"version":3,"sources":["../../src/util/server-client-utils.ts"],"names":[],"mappings":";AAUA,SAAS,UAAA,CAAW,MAAW,kBAA4C,EAAA;AACvE,EAAA,IAAI,CAAC,IAAA,IAAQ,OAAO,IAAA,KAAS,QAAU,EAAA;AACnC,IAAO,OAAA,IAAA;AAAA;AAGX,EAAA,MAAM,aAAa,KAAM,CAAA,OAAA,CAAQ,kBAAkB,CAAI,GAAA,kBAAA,GAAqB,CAAC,kBAAkB,CAAA;AAC/F,EAAM,MAAA,QAAA,GAAW,EAAE,GAAG,IAAK,EAAA;AAE3B,EAAA,KAAA,MAAW,QAAQ,UAAY,EAAA;AAC3B,IAAA,IAAI,QAAQ,QAAU,EAAA;AAClB,MAAA,QAAA,CAAS,IAAI,CAAA,GAAI,WAAY,CAAA,QAAA,CAAS,IAAI,CAAC,CAAA;AAAA;AAC/C;AAGJ,EAAO,OAAA,QAAA;AACX;AAOA,SAAS,YAAY,KAAiB,EAAA;AAClC,EAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC3B,IAAO,OAAA,YAAA;AAAA,GACA,MAAA,IAAA,KAAA,CAAM,OAAQ,CAAA,KAAK,CAAG,EAAA;AAC7B,IAAA,OAAO,MAAM,GAAI,CAAA,CAAC,IAAS,KAAA,WAAA,CAAY,IAAI,CAAC,CAAA;AAAA,GACrC,MAAA,IAAA,KAAA,IAAS,OAAO,KAAA,KAAU,QAAU,EAAA;AAC3C,IAAA,MAAM,cAAmB,EAAC;AAC1B,IAAA,KAAA,MAAW,OAAO,KAAO,EAAA;AACrB,MAAI,IAAA,KAAA,CAAM,cAAe,CAAA,GAAG,CAAG,EAAA;AAC3B,QAAA,WAAA,CAAY,GAAG,CAAA,GAAI,WAAY,CAAA,KAAA,CAAM,GAAG,CAAC,CAAA;AAAA;AAC7C;AAEJ,IAAO,OAAA,WAAA;AAAA;AAEX,EAAO,OAAA,KAAA;AACX;AAKA,SAAS,kBAAA,CAAmB,YAA+D,SAAyB,EAAA;AAChH,EAAA,IAAI,OAAO,UAAe,KAAA,QAAA,IAAY,UAAW,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AAC5D,IAAA,MAAM,IAAI,KAAM,CAAA,CAAA,mDAAA,EAAsD,SAAS,CAAA,cAAA,EAAiB,UAAU,CAAE,CAAA,CAAA;AAAA;AAEhH,EAAA,IAAI,OAAO,UAAA,KAAe,QAAY,IAAA,UAAA,KAAe,IAAM,EAAA;AACvD,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAG,EAAA;AACnD,MAAA,IAAI,OAAO,KAAU,KAAA,QAAA,IAAY,KAAM,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AAClD,QAAM,MAAA,IAAI,MAAM,CAAsD,mDAAA,EAAA,SAAS,IAAI,GAAG,CAAA,EAAA,EAAK,KAAK,CAAE,CAAA,CAAA;AAAA;AACtG;AACJ;AAER;AAQA,SAAS,cAAA,CAAe,WAAmB,UAAuE,EAAA;AAE9G,EAAA,kBAAA,CAAmB,YAAY,SAAS,CAAA;AAExC,EAAA,QAAQ,SAAW;AAAA,IACf,KAAK,SAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,MAAA;AAAA,IACL,KAAK,QAAA;AACD,MAAO,OAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,UAAU,CAAA,CAAA;AAAA,IACrC,KAAK,cAAA;AACD,MAAA,IAAI,OAAO,UAAA,KAAe,QAAY,IAAA,UAAA,KAAe,IAAM,EAAA;AACvD,QAAM,MAAA,IAAI,MAAM,4EAA4E,CAAA;AAAA;AAGhG,MAAA,MAAM,gBAAmB,GAAA,UAAA;AACzB,MAAA,IAAI,EAAE,OAAA,IAAW,gBAAqB,CAAA,IAAA,EAAE,YAAY,gBAAmB,CAAA,EAAA;AACnE,QAAM,MAAA,IAAI,MAAM,iFAAiF,CAAA;AAAA;AAGrG,MAAA,OAAO,CAAS,MAAA,EAAA,gBAAA,CAAiB,KAAK,CAAA,QAAA,EAAW,iBAAiB,MAAM,CAAA,CAAA;AAAA,IAE5E;AACI,MAAA,MAAM,IAAI,KAAA,CAAM,CAA0B,uBAAA,EAAA,SAAS,CAAE,CAAA,CAAA;AAAA;AAEjE;AAOA,SAAS,WAAW,KAAqG,EAAA;AACrH,EAAA,IAAI,CAAC,KAAA,IAAS,OAAO,KAAA,KAAU,QAAU,EAAA;AACrC,IAAM,MAAA,IAAI,MAAM,2CAA2C,CAAA;AAAA;AAG/D,EAAM,MAAA,KAAA,GAAQ,KAAM,CAAA,KAAA,CAAM,GAAG,CAAA;AAC7B,EAAI,IAAA,KAAA,CAAM,SAAS,CAAG,EAAA;AAClB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAyB,sBAAA,EAAA,KAAK,CAAyC,uCAAA,CAAA,CAAA;AAAA;AAG3F,EAAA,MAAM,CAAC,SAAA,EAAW,UAAY,EAAA,GAAG,SAAS,CAAI,GAAA,KAAA;AAG9C,EAAI,IAAA,SAAA,CAAU,UAAU,CAAK,IAAA,SAAA,KAAc,WAAW,SAAU,CAAA,CAAC,MAAM,QAAU,EAAA;AAC7E,IAAO,OAAA;AAAA,MACH,SAAW,EAAA,cAAA;AAAA,MACX,UAAY,EAAA;AAAA,QACR,KAAO,EAAA,UAAA;AAAA,QACP,MAAA,EAAQ,UAAU,CAAC;AAAA;AACvB,KACJ;AAAA;AAIJ,EAAI,IAAA,SAAA,CAAU,WAAW,CAAG,EAAA;AAExB,IAAM,MAAA,YAAA,GAAe,OAAO,UAAU,CAAA;AACtC,IAAM,MAAA,UAAA,GAAa,CAAC,KAAM,CAAA,YAAY,KAAK,QAAS,CAAA,YAAY,IAAI,YAAe,GAAA,UAAA;AAEnF,IAAO,OAAA;AAAA,MACH,SAAW,EAAA,SAAA;AAAA,MACX;AAAA,KACJ;AAAA;AAGJ,EAAA,MAAM,IAAI,KAAA,CAAM,CAA6B,0BAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AACxD","file":"server-client-utils.mjs","sourcesContent":["/*\n * These are utils that are safe to use both on the server and the client.\n */\n\n/**\n * Helper function to redact sensitive data from specified attributes\n * @param data - The object containing data to redact\n * @param attributesToRedact - Single attribute name or array of attribute names to redact\n * @returns A new object with specified attributes redacted\n */\nfunction redactData(data: any, attributesToRedact: string | string[]): any {\n    if (!data || typeof data !== 'object') {\n        return data;\n    }\n\n    const attributes = Array.isArray(attributesToRedact) ? attributesToRedact : [attributesToRedact];\n    const redacted = { ...data };\n\n    for (const attr of attributes) {\n        if (attr in redacted) {\n            redacted[attr] = redactValue(redacted[attr]);\n        }\n    }\n\n    return redacted;\n}\n\n/**\n * Recursively redacts a value based on its type\n * @param value - The value to redact\n * @returns The redacted value\n */\nfunction redactValue(value: any): any {\n    if (typeof value === 'string') {\n        return '[REDACTED]';\n    } else if (Array.isArray(value)) {\n        return value.map((item) => redactValue(item));\n    } else if (value && typeof value === 'object') {\n        const redactedObj: any = {};\n        for (const key in value) {\n            if (value.hasOwnProperty(key)) {\n                redactedObj[key] = redactValue(value[key]);\n            }\n        }\n        return redactedObj;\n    }\n    return value; // Return as-is for other types (numbers, booleans, null, etc.)\n}\n\n/**\n * Validates that a scope value doesn't contain the '#' character which is reserved for scope construction\n */\nfunction validateScopeValue(scopeValue: string | number | Record<string, string | number>, scopeType: string): void {\n    if (typeof scopeValue === 'string' && scopeValue.includes('#')) {\n        throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType} scope value: ${scopeValue}`);\n    }\n    if (typeof scopeValue === 'object' && scopeValue !== null) {\n        for (const [key, value] of Object.entries(scopeValue)) {\n            if (typeof value === 'string' && value.includes('#')) {\n                throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType}.${key}: ${value}`);\n            }\n        }\n    }\n}\n\n/**\n * Constructs a scope string from scopeType and scopeValue\n * @param scopeType - The type of scope (chatapp, agent, tool, entity, agent-entity)\n * @param scopeValue - The value(s) for the scope\n * @returns The constructed scope string\n */\nfunction constructScope(scopeType: string, scopeValue: string | number | Record<string, string | number>): string {\n    // Validate scope value doesn't contain '#'\n    validateScopeValue(scopeValue, scopeType);\n\n    switch (scopeType) {\n        case 'chatapp':\n        case 'agent':\n        case 'tool':\n        case 'entity':\n            return `${scopeType}#${scopeValue}`;\n        case 'agent-entity':\n            if (typeof scopeValue !== 'object' || scopeValue === null) {\n                throw new Error('agent-entity scopeType requires an object with agent and entity properties');\n            }\n\n            const agentEntityValue = scopeValue as Record<string, string | number>;\n            if (!('agent' in agentEntityValue) || !('entity' in agentEntityValue)) {\n                throw new Error('agent-entity scopeType requires an object with both agent and entity properties');\n            }\n\n            return `agent#${agentEntityValue.agent}#entity#${agentEntityValue.entity}`;\n\n        default:\n            throw new Error(`Unsupported scopeType: ${scopeType}`);\n    }\n}\n\n/**\n * Parses a scope string back into scopeType and scopeValue\n * @param scope - The scope string to parse\n * @returns Object containing scopeType and scopeValue\n */\nfunction parseScope(scope: string): { scopeType: string; scopeValue: string | number | Record<string, string | number> } {\n    if (!scope || typeof scope !== 'string') {\n        throw new Error('Invalid scope: must be a non-empty string');\n    }\n\n    const parts = scope.split('#');\n    if (parts.length < 2) {\n        throw new Error(`Invalid scope format: ${scope}. Expected format: scopeType#scopeValue`);\n    }\n\n    const [firstType, firstValue, ...remaining] = parts;\n\n    // Handle compound scopes (agent-entity)\n    if (remaining.length >= 2 && firstType === 'agent' && remaining[0] === 'entity') {\n        return {\n            scopeType: 'agent-entity',\n            scopeValue: {\n                agent: firstValue,\n                entity: remaining[1]\n            }\n        };\n    }\n\n    // Handle simple scopes\n    if (remaining.length === 0) {\n        // For simple scopes, try to convert to number if it's numeric\n        const numericValue = Number(firstValue);\n        const scopeValue = !isNaN(numericValue) && isFinite(numericValue) ? numericValue : firstValue;\n\n        return {\n            scopeType: firstType,\n            scopeValue: scopeValue\n        };\n    }\n\n    throw new Error(`Unsupported scope format: ${scope}`);\n}\n\n// Export both functions\nexport { redactData, redactValue, constructScope, parseScope };\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pika-shared",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -32,6 +32,13 @@
     "typescript": "^5.9.2",
     "@pika/typescript-config": "0.0.0"
   },
+  "keywords": [
+    "pika",
+    "chatbot",
+    "agent",
+    "ai",
+    "chatapp"
+  ],
   "files": [
     "dist/**"
   ],

package/readme.md

@@ -1,3 +1,11 @@
 # Shared libraries go in here
 
 This is mostly for shared types and utilities.
+
+## Dev Instructions
+
+To publish...
+
+1. `pnpm run version:major` or `pnpm run version:minor` or `pnpm run version:patch`
+2. commit and push changes
+3. pnpm publish