@epilot/sdk 2.20.11 → 2.20.13-alpha.0

package/docs/environments.md

@@ -41,6 +41,16 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
 - [`MapValue`](#mapvalue)
 - [`JsonValue`](#jsonvalue)
 - [`LinkValue`](#linkvalue)
+- [`LinkFields`](#linkfields)
+- [`ListItemType`](#listitemtype)
+- [`ListOfText`](#listoftext)
+- [`ListOfString`](#listofstring)
+- [`ListOfSecretString`](#listofsecretstring)
+- [`ListOfNumber`](#listofnumber)
+- [`ListOfBoolean`](#listofboolean)
+- [`ListOfJson`](#listofjson)
+- [`ListOfLink`](#listoflink)
+- [`ListValue`](#listvalue)
 - [`EnvironmentValue`](#environmentvalue)
 - [`EnvironmentVariable`](#environmentvariable)
 - [`EnvironmentVariableListItem`](#environmentvariablelistitem)
@@ -70,6 +80,7 @@ const { data } = await client.listEnvironmentVariables()
     {
       "key": "string",
       "type": "String",
+      "item_type": "String",
       "description": "string",
       "group": "string",
       "value": "string",
@@ -112,6 +123,7 @@ const { data } = await client.createEnvironmentVariable(
 {
   "key": "string",
   "type": "String",
+  "item_type": "String",
   "description": "string",
   "group": "string",
   "value": "string",
@@ -221,6 +233,7 @@ const { data } = await client.getEnvironmentVariable({
 {
   "key": "string",
   "type": "String",
+  "item_type": "String",
   "description": "string",
   "group": "string",
   "value": "string",
@@ -262,6 +275,7 @@ const { data } = await client.updateEnvironmentVariable(
 {
   "key": "string",
   "type": "String",
+  "item_type": "String",
   "description": "string",
   "group": "string",
   "value": "string",
@@ -295,11 +309,11 @@ const { data } = await client.deleteEnvironmentVariable({
 
 The structure a variable's value holds. `SecretString` is encrypted at rest and
 its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
-may be served to browser-facing consumers; `String` and `SecretString` may not.
-
+may be served to browser-facing consumers; `String` and `SecretString` may not. A
+`List` inherits this from its element type: a `List` is
 
 ```ts
-type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
+type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
 ```
 
 ### `StringTranslations`
@@ -369,13 +383,160 @@ type LinkValue = {
 }
 ```
 
+### `LinkFields`
+
+The fields of a link, without a fallback language — the shape a `List`
+item carries. Inside a list the fallback belongs to the wrapper, which
+owns the language tabs for every row.
+
+Restated rather than composed with `LinkValue`: `allOf` plus
+`additionalProperties: false` is rejected by most validato
+
+```ts
+type LinkFields = {
+  url: string
+  label: string | Record<string, string>
+  description?: string | Record<string, string>
+}
+```
+
+### `ListItemType`
+
+The element type a `List` holds — every value type except the
+containers. `Map` is already a keyed collection and a list of lists has
+no consumer. A list is exactly as client-safe and exactly as secret as
+its element type: a list of `SecretString` is encrypted per item and its
+value is never returne
+
+```ts
+type ListItemType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
+```
+
+### `ListOfText`
+
+```ts
+type ListOfText = {
+  itemType: "Text"
+  items: string[]
+}
+```
+
+### `ListOfString`
+
+```ts
+type ListOfString = {
+  itemType: "String"
+  items: string[]
+}
+```
+
+### `ListOfSecretString`
+
+Write-only in effect: the items are encrypted per item at rest and the
+whole value is omitted from every read response, exactly as a
+`SecretString` variable's value is. Read `item_type` to learn what a
+list holds when its value is withheld.
+
+
+```ts
+type ListOfSecretString = {
+  itemType: "SecretString"
+  items: string[]
+}
+```
+
+### `ListOfNumber`
+
+```ts
+type ListOfNumber = {
+  itemType: "Number"
+  items: number[]
+}
+```
+
+### `ListOfBoolean`
+
+```ts
+type ListOfBoolean = {
+  itemType: "Boolean"
+  items: boolean[]
+}
+```
+
+### `ListOfJson`
+
+```ts
+type ListOfJson = {
+  itemType: "JSON"
+  items: Record<string, unknown>[]
+}
+```
+
+### `ListOfLink`
+
+A list of links. `fallbackLanguage` applies to every item's translated
+`label` and `description`; items may mix plain and translated fields
+freely, since a plain string is a complete answer for any language.
+
+
+```ts
+type ListOfLink = {
+  itemType: "Link"
+  fallbackLanguage?: string
+  items: Array<{
+    url: string
+    label: string | Record<string, string>
+    description?: string | Record<string, string>
+  }>
+}
+```
+
+### `ListValue`
+
+An ordered collection of one declared element type. Items round-trip in
+the order written; nothing sorts them. Holds at most 100 items.
+
+The whole value is limited to 32768 characters when serialised — the
+server enforces this, and it is not expressible per-property here.
+
+
+```ts
+type ListValue = {
+  itemType: "Text"
+  items: string[]
+} | {
+  itemType: "Number"
+  items: number[]
+} | {
+  itemType: "Boolean"
+  items: boolean[]
+} | {
+  itemType: "JSON"
+  items: Record<string, unknown>[]
+} | {
+  itemType: "Link"
+  fallbackLanguage?: string
+  items: Array<{
+    url: string
+    label: string | Record<string, string>
+    description?: string | Record<string, string>
+  }>
+} | {
+  itemType: "String"
+  items: string[]
+} | {
+  itemType: "SecretString"
+  items: string[]
+}
+```
+
 ### `EnvironmentValue`
 
 A variable's value. The JSON type corresponds to the variable's `type`:
 `String`, `SecretString` and `Text` are strings, `Number` is a number,
-`Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
-IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
-
+`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
+Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
+round-trip.
 
 ```ts
 type EnvironmentValue = string | number | boolean | {
@@ -389,6 +550,32 @@ type EnvironmentValue = string | number | boolean | {
   label: string | Record<string, string>
   description?: string | Record<string, string>
   fallbackLanguage?: string
+} | {
+  itemType: "Text"
+  items: string[]
+} | {
+  itemType: "Number"
+  items: number[]
+} | {
+  itemType: "Boolean"
+  items: boolean[]
+} | {
+  itemType: "JSON"
+  items: Record<string, unknown>[]
+} | {
+  itemType: "Link"
+  fallbackLanguage?: string
+  items: Array<{
+    url: string
+    label: string | Record<string, string>
+    description?: string | Record<string, string>
+  }>
+} | {
+  itemType: "String"
+  items: string[]
+} | {
+  itemType: "SecretString"
+  items: string[]
 }
 ```
 
@@ -397,7 +584,8 @@ type EnvironmentValue = string | number | boolean | {
 ```ts
 type EnvironmentVariable = {
   key: string
-  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+  item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
   description?: string
   group?: string
   value?: string | number | boolean | {
@@ -411,6 +599,32 @@ type EnvironmentVariable = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
+  } | {
+    itemType: "Text"
+    items: string[]
+  } | {
+    itemType: "Number"
+    items: number[]
+  } | {
+    itemType: "Boolean"
+    items: boolean[]
+  } | {
+    itemType: "JSON"
+    items: Record<string, unknown>[]
+  } | {
+    itemType: "Link"
+    fallbackLanguage?: string
+    items: Array<{
+      url: { ... }
+      label: { ... }
+      description?: { ... }
+    }>
+  } | {
+    itemType: "String"
+    items: string[]
+  } | {
+    itemType: "SecretString"
+    items: string[]
   }
   protected?: boolean
   created_at: string // date-time
@@ -423,7 +637,8 @@ type EnvironmentVariable = {
 ```ts
 type EnvironmentVariableListItem = {
   key: string
-  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+  item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
   description?: string
   group?: string
   value?: string | number | boolean | {
@@ -437,6 +652,32 @@ type EnvironmentVariableListItem = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
+  } | {
+    itemType: "Text"
+    items: string[]
+  } | {
+    itemType: "Number"
+    items: number[]
+  } | {
+    itemType: "Boolean"
+    items: boolean[]
+  } | {
+    itemType: "JSON"
+    items: Record<string, unknown>[]
+  } | {
+    itemType: "Link"
+    fallbackLanguage?: string
+    items: Array<{
+      url: { ... }
+      label: { ... }
+      description?: { ... }
+    }>
+  } | {
+    itemType: "String"
+    items: string[]
+  } | {
+    itemType: "SecretString"
+    items: string[]
   }
   protected?: boolean
   created_at: string // date-time
@@ -450,7 +691,8 @@ type EnvironmentVariableListItem = {
 type EnvironmentVariableList = {
   items: Array<{
     key: string
-    type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
+    type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+    item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
     description?: string
     group?: string
     value?: string | number | boolean | {
@@ -461,6 +703,28 @@ type EnvironmentVariableList = {
       label: { ... }
       description?: { ... }
       fallbackLanguage?: { ... }
+    } | {
+      itemType: { ... }
+      items: { ... }
+    } | {
+      itemType: { ... }
+      items: { ... }
+    } | {
+      itemType: { ... }
+      items: { ... }
+    } | {
+      itemType: { ... }
+      items: { ... }
+    } | {
+      itemType: { ... }
+      fallbackLanguage?: { ... }
+      items: { ... }
+    } | {
+      itemType: { ... }
+      items: { ... }
+    } | {
+      itemType: { ... }
+      items: { ... }
     }
     protected?: boolean
     created_at: string // date-time
@@ -474,7 +738,7 @@ type EnvironmentVariableList = {
 ```ts
 type EnvironmentVariableCreateRequest = {
   key: string
-  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
   description?: string
   group?: string
   value?: string | number | boolean | {
@@ -488,6 +752,32 @@ type EnvironmentVariableCreateRequest = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
+  } | {
+    itemType: "Text"
+    items: string[]
+  } | {
+    itemType: "Number"
+    items: number[]
+  } | {
+    itemType: "Boolean"
+    items: boolean[]
+  } | {
+    itemType: "JSON"
+    items: Record<string, unknown>[]
+  } | {
+    itemType: "Link"
+    fallbackLanguage?: string
+    items: Array<{
+      url: { ... }
+      label: { ... }
+      description?: { ... }
+    }>
+  } | {
+    itemType: "String"
+    items: string[]
+  } | {
+    itemType: "SecretString"
+    items: string[]
   }
   protected?: boolean
 }
@@ -497,7 +787,7 @@ type EnvironmentVariableCreateRequest = {
 
 ```ts
 type EnvironmentVariableUpdateRequest = {
-  type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
+  type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
   value?: string | number | boolean | {
     fallbackLanguage?: string
     options: Array<{
@@ -509,6 +799,32 @@ type EnvironmentVariableUpdateRequest = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
+  } | {
+    itemType: "Text"
+    items: string[]
+  } | {
+    itemType: "Number"
+    items: number[]
+  } | {
+    itemType: "Boolean"
+    items: boolean[]
+  } | {
+    itemType: "JSON"
+    items: Record<string, unknown>[]
+  } | {
+    itemType: "Link"
+    fallbackLanguage?: string
+    items: Array<{
+      url: { ... }
+      label: { ... }
+      description?: { ... }
+    }>
+  } | {
+    itemType: "String"
+    items: string[]
+  } | {
+    itemType: "SecretString"
+    items: string[]
   }
   description?: string
   group?: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.11",
+  "version": "2.20.13-alpha.0",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",