@copilotkit/shared 0.5.0-mme-function-call-labels.2 → 0.5.0-mme-prerelease-demo.3

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @copilotkit/shared@0.5.0-mme-function-call-labels.2 build /home/runner/work/CopilotKit/CopilotKit/CopilotKit/packages/shared
+> @copilotkit/shared@0.5.0-mme-prerelease-demo.3 build /home/runner/work/CopilotKit/CopilotKit/CopilotKit/packages/shared
 > tsup --clean
 
 CLI Building entry: src/index.ts, src/constants/copilot-protocol.ts, src/constants/index.ts, src/types/action.ts, src/types/annotated-function.ts, src/types/index.ts, src/types/openai-assistant.ts, src/utils/annotated-function.ts, src/utils/decode-chat-completion-as-text.ts, src/utils/decode-chat-completion.ts, src/utils/index.ts, src/utils/parse-chat-completion.ts, src/utils/utils.test.ts, src/utils/utils.ts
@@ -22,12 +22,12 @@
 CJS dist/utils/decode-chat-completion.js             4.42 KB
 CJS dist/utils/index.js                              15.26 KB
 CJS dist/utils/parse-chat-completion.js              2.68 KB
-CJS dist/utils/utils.js                              6.25 KB
 CJS dist/utils/utils.test.js                         184.00 B
+CJS dist/utils/utils.js                              6.25 KB
 CJS dist/index.js.map                                30.29 KB
 CJS dist/constants/copilot-protocol.js.map           261.00 B
 CJS dist/constants/index.js.map                      336.00 B
-CJS dist/types/action.js.map                         2.94 KB
+CJS dist/types/action.js.map                         4.59 KB
 CJS dist/types/annotated-function.js.map             871.00 B
 CJS dist/types/index.js.map                          234.00 B
 CJS dist/types/openai-assistant.js.map               2.86 KB
@@ -36,9 +36,9 @@
 CJS dist/utils/decode-chat-completion.js.map         6.89 KB
 CJS dist/utils/index.js.map                          30.28 KB
 CJS dist/utils/parse-chat-completion.js.map          4.15 KB
-CJS dist/utils/utils.js.map                          12.08 KB
 CJS dist/utils/utils.test.js.map                     354.00 B
-CJS ⚡️ Build success in 64ms
+CJS dist/utils/utils.js.map                          12.08 KB
+CJS ⚡️ Build success in 75ms
 ESM dist/index.mjs                                    1.17 KB
 ESM dist/constants/copilot-protocol.mjs               166.00 B
 ESM dist/types/action.mjs                             67.00 B
@@ -48,9 +48,9 @@
 ESM dist/chunk-NKEDWRKJ.mjs                           3.36 KB
 ESM dist/chunk-TYZD5BQY.mjs                           1.63 KB
 ESM dist/chunk-2C54HQBI.mjs                           4.92 KB
+ESM dist/constants/index.mjs                          187.00 B
 ESM dist/chunk-2M3YVRFS.mjs                           43.00 B
 ESM dist/chunk-3ZU7SB62.mjs                           200.00 B
-ESM dist/constants/index.mjs                          187.00 B
 ESM dist/types/annotated-function.mjs                 79.00 B
 ESM dist/types/index.mjs                              162.00 B
 ESM dist/chunk-DE5K76I2.mjs                           43.00 B
@@ -62,8 +62,8 @@
 ESM dist/utils/decode-chat-completion-as-text.mjs     170.00 B
 ESM dist/utils/decode-chat-completion.mjs             150.00 B
 ESM dist/utils/index.mjs                              943.00 B
-ESM dist/utils/utils.test.mjs                         170.00 B
 ESM dist/utils/parse-chat-completion.mjs              147.00 B
+ESM dist/utils/utils.test.mjs                         170.00 B
 ESM dist/utils/utils.mjs                              439.00 B
 ESM dist/index.mjs.map                                71.00 B
 ESM dist/constants/copilot-protocol.mjs.map           71.00 B
@@ -74,9 +74,9 @@
 ESM dist/chunk-NKEDWRKJ.mjs.map                       6.85 KB
 ESM dist/chunk-TYZD5BQY.mjs.map                       4.10 KB
 ESM dist/chunk-2C54HQBI.mjs.map                       12.00 KB
+ESM dist/constants/index.mjs.map                      71.00 B
 ESM dist/chunk-2M3YVRFS.mjs.map                       71.00 B
 ESM dist/chunk-3ZU7SB62.mjs.map                       214.00 B
-ESM dist/constants/index.mjs.map                      71.00 B
 ESM dist/types/annotated-function.mjs.map             71.00 B
 ESM dist/types/index.mjs.map                          71.00 B
 ESM dist/chunk-DE5K76I2.mjs.map                       71.00 B
@@ -88,16 +88,16 @@
 ESM dist/utils/decode-chat-completion-as-text.mjs.map 71.00 B
 ESM dist/utils/decode-chat-completion.mjs.map         71.00 B
 ESM dist/utils/index.mjs.map                          71.00 B
-ESM dist/utils/utils.test.mjs.map                     352.00 B
 ESM dist/utils/parse-chat-completion.mjs.map          71.00 B
+ESM dist/utils/utils.test.mjs.map                     352.00 B
 ESM dist/utils/utils.mjs.map                          71.00 B
-ESM ⚡️ Build success in 70ms
+ESM ⚡️ Build success in 79ms
 DTS Build start
-DTS ⚡️ Build success in 2150ms
+DTS ⚡️ Build success in 2127ms
 DTS dist/index.d.ts                                1.25 KB
 DTS dist/types/openai-assistant.d.ts               2.79 KB
 DTS dist/types/annotated-function.d.ts             766.00 B
-DTS dist/types/action.d.ts                         1.86 KB
+DTS dist/types/action.d.ts                         2.09 KB
 DTS dist/utils/utils.d.ts                          4.32 KB
 DTS dist/utils/parse-chat-completion.d.ts          805.00 B
 DTS dist/utils/decode-chat-completion.d.ts         955.00 B

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @copilotkit/shared
 
+## 0.5.0-mme-prerelease-demo.3
+
+### Minor Changes
+
+- 3fbee5d: OpenAIAdapter-getter
+- 3f5ad60: OpenAIAdapter: make openai instance gettable
+- Pre release for demos
+
 ## 0.5.0-mme-function-call-labels.2
 
 ### Minor Changes

package/dist/types/action.d.ts

@@ -29,20 +29,23 @@ type ObjectParameter = {
     attributes?: Parameter[];
 };
 type Parameter = BaseParameter | StringParameter | ObjectParameter;
+type EnumParameterType<E, Required> = E extends string ? Required extends false ? E | undefined : E : never;
+type ObjectTypeParameter<Attributes> = Attributes extends Parameter[] ? MappedParameterTypes<Attributes> : never;
+type ObjectArrayTypeParameter<Attributes> = Attributes extends Parameter[] ? MappedParameterTypes<Attributes>[] : any[];
+type OtherParameterType<Type, Required> = Required extends false ? TypeMap[Type extends keyof TypeMap ? Type : "string"] | undefined : TypeMap[Type extends keyof TypeMap ? Type : "string"];
 type MappedParameterTypes<T extends Parameter[]> = {
     [P in T[number] as P["name"]]: P extends {
         enum: Array<infer E>;
-    } ? E extends string ? P["required"] extends false ? E | undefined : E : never : P extends {
+    } ? EnumParameterType<E, P["required"]> : P extends {
         type: "object";
         attributes: infer Attributes;
-    } ? Attributes extends Parameter[] ? MappedParameterTypes<Attributes> : never : P extends {
+    } ? ObjectTypeParameter<Attributes> : P extends {
         type: "object[]";
         attributes?: never;
     } ? any[] : P extends {
         type: "object[]";
         attributes: infer Attributes;
-    } ? Attributes extends Parameter[] ? MappedParameterTypes<Attributes>[] : any[] : P["required"] extends false ? // Include 'undefined' for optional parameters
-    TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"] | undefined : TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"];
+    } ? ObjectArrayTypeParameter<Attributes> : OtherParameterType<P["type"], P["required"]>;
 };
 type Action<T extends Parameter[] | [] = []> = {
     name: string;

package/dist/types/action.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/action.ts"],"sourcesContent":["type TypeMap = {\n  string: string;\n  number: number;\n  boolean: boolean;\n  object: object;\n  \"string[]\": string[];\n  \"number[]\": number[];\n  \"boolean[]\": boolean[];\n  \"object[]\": object[];\n};\n\nexport type BaseParameter = {\n  name: string;\n  type?: Exclude<keyof TypeMap, \"string\" | \"object\" | \"object[]\">; // Exclude object types for BaseParameter\n  description?: string;\n  required?: boolean;\n};\n\nexport type StringParameter = {\n  name: string;\n  type: \"string\";\n  description?: string;\n  required?: boolean;\n  enum?: string[];\n};\n\nexport type ObjectParameter = {\n  name: string;\n  type: \"object\" | \"object[]\";\n  description?: string;\n  required?: boolean;\n  attributes?: Parameter[];\n};\n\nexport type Parameter = BaseParameter | StringParameter | ObjectParameter;\n\nexport type MappedParameterTypes<T extends Parameter[]> = {\n  // Check if the parameter has an 'enum' defined\n  [P in T[number] as P[\"name\"]]: P extends { enum: Array<infer E> }\n    ? E extends string // Ensure the enum values are strings\n      ? P[\"required\"] extends false // Check if the parameter is optional\n        ? E | undefined // If so, include 'undefined' in the type\n        : E // Otherwise, use the enum type directly\n      : never // This case should not occur since 'enum' implies string values\n    : // Handle parameters defined as 'object' with specified attributes\n    P extends { type: \"object\"; attributes: infer Attributes }\n    ? Attributes extends Parameter[]\n      ? MappedParameterTypes<Attributes> // Recursively map the attributes of the object\n      : never // If 'attributes' is not an array of Parameters, this is invalid\n    : // Handle parameters defined as 'object[]' without specified attributes\n    P extends { type: \"object[]\"; attributes?: never }\n    ? any[] // Default to 'any[]' for arrays of objects without specific attributes\n    : // Handle parameters defined as 'object[]' with specified attributes\n    P extends { type: \"object[]\"; attributes: infer Attributes }\n    ? Attributes extends Parameter[]\n      ? MappedParameterTypes<Attributes>[] // Recursively map each object in the array\n      : any[] // Default to 'any[]' if attributes are not properly defined\n    : // Handle all other parameter types\n    P[\"required\"] extends false\n    ? // Include 'undefined' for optional parameters\n      TypeMap[P[\"type\"] extends keyof TypeMap ? P[\"type\"] : \"string\"] | undefined\n    : // Use the direct mapping from 'TypeMap' for the parameter's type\n      TypeMap[P[\"type\"] extends keyof TypeMap ? P[\"type\"] : \"string\"];\n};\n\nexport type Action<T extends Parameter[] | [] = []> = {\n  name: string;\n  description?: string;\n  parameters?: T;\n  handler: T extends []\n    ? () => any | Promise<any>\n    : (args: MappedParameterTypes<T>) => any | Promise<any>;\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/action.ts"],"sourcesContent":["type TypeMap = {\n  string: string;\n  number: number;\n  boolean: boolean;\n  object: object;\n  \"string[]\": string[];\n  \"number[]\": number[];\n  \"boolean[]\": boolean[];\n  \"object[]\": object[];\n};\n\nexport type BaseParameter = {\n  name: string;\n  type?: Exclude<keyof TypeMap, \"string\" | \"object\" | \"object[]\">; // Exclude object types for BaseParameter\n  description?: string;\n  required?: boolean;\n};\n\nexport type StringParameter = {\n  name: string;\n  type: \"string\";\n  description?: string;\n  required?: boolean;\n  enum?: string[];\n};\n\nexport type ObjectParameter = {\n  name: string;\n  type: \"object\" | \"object[]\";\n  description?: string;\n  required?: boolean;\n  attributes?: Parameter[];\n};\n\nexport type Parameter = BaseParameter | StringParameter | ObjectParameter;\n\ntype EnumParameterType<E, Required> = E extends string\n  ? Required extends false\n    ? E | undefined\n    : E\n  : never;\n\ntype ObjectTypeParameter<Attributes> = Attributes extends Parameter[]\n  ? MappedParameterTypes<Attributes>\n  : never;\n\ntype ObjectArrayTypeParameter<Attributes> = Attributes extends Parameter[]\n  ? MappedParameterTypes<Attributes>[]\n  : any[];\n\ntype OtherParameterType<Type, Required> = Required extends false\n  ? TypeMap[Type extends keyof TypeMap ? Type : \"string\"] | undefined\n  : TypeMap[Type extends keyof TypeMap ? Type : \"string\"];\n\n// prettier-ignore\nexport type MappedParameterTypes<T extends Parameter[]> = {\n    [P in T[number] as P[\"name\"]]: P extends { enum: Array<infer E> } ? EnumParameterType<E, P[\"required\"]>\n    : P extends { type: \"object\"; attributes: infer Attributes } ? ObjectTypeParameter<Attributes>\n    : P extends { type: \"object[]\"; attributes?: never } ? any[]\n    : P extends { type: \"object[]\"; attributes: infer Attributes } ? ObjectArrayTypeParameter<Attributes>\n    : OtherParameterType<P[\"type\"], P[\"required\"]>;\n};\n\nexport type Action<T extends Parameter[] | [] = []> = {\n  name: string;\n  description?: string;\n  parameters?: T;\n  handler: T extends []\n    ? () => any | Promise<any>\n    : (args: MappedParameterTypes<T>) => any | Promise<any>;\n};\n\n// This is the original \"ceiling is being raised\" version of MappedParameterTypes.\n//\n// ceiling is being raised. cursor's copilot helped us write \"superhuman code\"\n// for a critical feature. We can read this code, but VERY few engineers out\n// there could write it from scratch.\n// Took lots of convincing too. \"come on, this must be possible, try harder\".\n// and obviously- done in parts.\n//\n// - https://twitter.com/ataiiam/status/1765089261374914957\n//   (Mar 5, 2024)\n//\n// export type MappedParameterTypes<T extends Parameter[]> = {\n//   // Check if the parameter has an 'enum' defined\n//   [P in T[number] as P[\"name\"]]: P extends { enum: Array<infer E> }\n//     ? E extends string // Ensure the enum values are strings\n//       ? P[\"required\"] extends false // Check if the parameter is optional\n//         ? E | undefined // If so, include 'undefined' in the type\n//         : E // Otherwise, use the enum type directly\n//       : never // This case should not occur since 'enum' implies string values\n//     : // Handle parameters defined as 'object' with specified attributes\n//     P extends { type: \"object\"; attributes: infer Attributes }\n//     ? Attributes extends Parameter[]\n//       ? MappedParameterTypes<Attributes> // Recursively map the attributes of the object\n//       : never // If 'attributes' is not an array of Parameters, this is invalid\n//     : // Handle parameters defined as 'object[]' without specified attributes\n//     P extends { type: \"object[]\"; attributes?: never }\n//     ? any[] // Default to 'any[]' for arrays of objects without specific attributes\n//     : // Handle parameters defined as 'object[]' with specified attributes\n//     P extends { type: \"object[]\"; attributes: infer Attributes }\n//     ? Attributes extends Parameter[]\n//       ? MappedParameterTypes<Attributes>[] // Recursively map each object in the array\n//       : any[] // Default to 'any[]' if attributes are not properly defined\n//     : // Handle all other parameter types\n//     P[\"required\"] extends false\n//     ? // Include 'undefined' for optional parameters\n//       TypeMap[P[\"type\"] extends keyof TypeMap ? P[\"type\"] : \"string\"] | undefined\n//     : // Use the direct mapping from 'TypeMap' for the parameter's type\n//       TypeMap[P[\"type\"] extends keyof TypeMap ? P[\"type\"] : \"string\"];\n// };\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.5.0-mme-function-call-labels.2",
+  "version": "0.5.0-mme-prerelease-demo.3",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -21,8 +21,8 @@
     "ts-jest": "^29.1.1",
     "tsup": "^6.7.0",
     "typescript": "^5.2.3",
-    "eslint-config-custom": "0.6.0-mme-function-call-labels.2",
-    "tsconfig": "0.10.0-mme-function-call-labels.2"
+    "eslint-config-custom": "0.6.0-mme-prerelease-demo.3",
+    "tsconfig": "0.10.0-mme-prerelease-demo.3"
   },
   "dependencies": {},
   "scripts": {

package/src/types/action.ts

@@ -34,33 +34,31 @@ export type ObjectParameter = {
 
 export type Parameter = BaseParameter | StringParameter | ObjectParameter;
 
+type EnumParameterType<E, Required> = E extends string
+  ? Required extends false
+    ? E | undefined
+    : E
+  : never;
+
+type ObjectTypeParameter<Attributes> = Attributes extends Parameter[]
+  ? MappedParameterTypes<Attributes>
+  : never;
+
+type ObjectArrayTypeParameter<Attributes> = Attributes extends Parameter[]
+  ? MappedParameterTypes<Attributes>[]
+  : any[];
+
+type OtherParameterType<Type, Required> = Required extends false
+  ? TypeMap[Type extends keyof TypeMap ? Type : "string"] | undefined
+  : TypeMap[Type extends keyof TypeMap ? Type : "string"];
+
+// prettier-ignore
 export type MappedParameterTypes<T extends Parameter[]> = {
-  // Check if the parameter has an 'enum' defined
-  [P in T[number] as P["name"]]: P extends { enum: Array<infer E> }
-    ? E extends string // Ensure the enum values are strings
-      ? P["required"] extends false // Check if the parameter is optional
-        ? E | undefined // If so, include 'undefined' in the type
-        : E // Otherwise, use the enum type directly
-      : never // This case should not occur since 'enum' implies string values
-    : // Handle parameters defined as 'object' with specified attributes
-    P extends { type: "object"; attributes: infer Attributes }
-    ? Attributes extends Parameter[]
-      ? MappedParameterTypes<Attributes> // Recursively map the attributes of the object
-      : never // If 'attributes' is not an array of Parameters, this is invalid
-    : // Handle parameters defined as 'object[]' without specified attributes
-    P extends { type: "object[]"; attributes?: never }
-    ? any[] // Default to 'any[]' for arrays of objects without specific attributes
-    : // Handle parameters defined as 'object[]' with specified attributes
-    P extends { type: "object[]"; attributes: infer Attributes }
-    ? Attributes extends Parameter[]
-      ? MappedParameterTypes<Attributes>[] // Recursively map each object in the array
-      : any[] // Default to 'any[]' if attributes are not properly defined
-    : // Handle all other parameter types
-    P["required"] extends false
-    ? // Include 'undefined' for optional parameters
-      TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"] | undefined
-    : // Use the direct mapping from 'TypeMap' for the parameter's type
-      TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"];
+    [P in T[number] as P["name"]]: P extends { enum: Array<infer E> } ? EnumParameterType<E, P["required"]>
+    : P extends { type: "object"; attributes: infer Attributes } ? ObjectTypeParameter<Attributes>
+    : P extends { type: "object[]"; attributes?: never } ? any[]
+    : P extends { type: "object[]"; attributes: infer Attributes } ? ObjectArrayTypeParameter<Attributes>
+    : OtherParameterType<P["type"], P["required"]>;
 };
 
 export type Action<T extends Parameter[] | [] = []> = {
@@ -71,3 +69,43 @@ export type Action<T extends Parameter[] | [] = []> = {
     ? () => any | Promise<any>
     : (args: MappedParameterTypes<T>) => any | Promise<any>;
 };
+
+// This is the original "ceiling is being raised" version of MappedParameterTypes.
+//
+// ceiling is being raised. cursor's copilot helped us write "superhuman code"
+// for a critical feature. We can read this code, but VERY few engineers out
+// there could write it from scratch.
+// Took lots of convincing too. "come on, this must be possible, try harder".
+// and obviously- done in parts.
+//
+// - https://twitter.com/ataiiam/status/1765089261374914957
+//   (Mar 5, 2024)
+//
+// export type MappedParameterTypes<T extends Parameter[]> = {
+//   // Check if the parameter has an 'enum' defined
+//   [P in T[number] as P["name"]]: P extends { enum: Array<infer E> }
+//     ? E extends string // Ensure the enum values are strings
+//       ? P["required"] extends false // Check if the parameter is optional
+//         ? E | undefined // If so, include 'undefined' in the type
+//         : E // Otherwise, use the enum type directly
+//       : never // This case should not occur since 'enum' implies string values
+//     : // Handle parameters defined as 'object' with specified attributes
+//     P extends { type: "object"; attributes: infer Attributes }
+//     ? Attributes extends Parameter[]
+//       ? MappedParameterTypes<Attributes> // Recursively map the attributes of the object
+//       : never // If 'attributes' is not an array of Parameters, this is invalid
+//     : // Handle parameters defined as 'object[]' without specified attributes
+//     P extends { type: "object[]"; attributes?: never }
+//     ? any[] // Default to 'any[]' for arrays of objects without specific attributes
+//     : // Handle parameters defined as 'object[]' with specified attributes
+//     P extends { type: "object[]"; attributes: infer Attributes }
+//     ? Attributes extends Parameter[]
+//       ? MappedParameterTypes<Attributes>[] // Recursively map each object in the array
+//       : any[] // Default to 'any[]' if attributes are not properly defined
+//     : // Handle all other parameter types
+//     P["required"] extends false
+//     ? // Include 'undefined' for optional parameters
+//       TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"] | undefined
+//     : // Use the direct mapping from 'TypeMap' for the parameter's type
+//       TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"];
+// };