@xyo-network/api 2.20.15

package/src/Diviner/LocationDiviner/LocationDivinerApi.ts

@@ -0,0 +1,29 @@
+import { ApiConfig } from '@xylabs/sdk-js'
+import axios, { AxiosRequestConfig } from 'axios'
+
+import { getLocationDivinerApiResponseTransformer } from './LocationDivinerApiResponseTransformer'
+import { GetLocationQueryResponse } from './models'
+import { LocationQueryCreationResponse, SupportedLocationQueryCreationRequest } from './Queries'
+
+class XyoLocationDivinerApi {
+  public config: ApiConfig
+  constructor(config: ApiConfig) {
+    this.config = config
+  }
+
+  private get axiosRequestConfig(): AxiosRequestConfig {
+    return {
+      transformResponse: getLocationDivinerApiResponseTransformer(),
+    }
+  }
+
+  public async getLocationQuery(hash: string) {
+    return (await axios.get<GetLocationQueryResponse>(`${this.config.apiDomain}/location/query/${hash}`, this.axiosRequestConfig)).data
+  }
+
+  public async postLocationQuery(request: SupportedLocationQueryCreationRequest) {
+    return (await axios.post<LocationQueryCreationResponse>(`${this.config.apiDomain}/location/query`, { ...request }, this.axiosRequestConfig)).data
+  }
+}
+
+export { XyoLocationDivinerApi }

package/src/Diviner/LocationDiviner/LocationDivinerApiResponseTransformer.ts

@@ -0,0 +1,19 @@
+import axios, { AxiosResponseTransformer } from 'axios'
+
+export const locationDivinerApiResponseTransformer: AxiosResponseTransformer = (data, _headers) => {
+  return data.data
+}
+
+/**
+ * Gets the response transformers for the LocationDiviner API. Done as a method instead of a property
+ * to allow detection of dynamically added response transformers.
+ * @param axiosInstance The axios instance (defaults to the global instance if none provided)
+ * @returns the response transformers for the LocationDiviner API
+ */
+export const getLocationDivinerApiResponseTransformer = (axiosInstance = axios): AxiosResponseTransformer[] => {
+  // If there's any existing response transforms preserve them and
+  // append our response transform, otherwise just return ours
+  return axiosInstance.defaults.transformResponse
+    ? ([] as AxiosResponseTransformer[]).concat(axiosInstance.defaults.transformResponse, locationDivinerApiResponseTransformer)
+    : [locationDivinerApiResponseTransformer]
+}

package/src/Diviner/LocationDiviner/Queries/LocationHeatmapQuery/LocationHeatmapPointProperties.ts

@@ -0,0 +1,4 @@
+export interface LocationHeatmapPointProperties {
+  hash: string
+  value: number
+}

package/src/Diviner/LocationDiviner/Queries/LocationHeatmapQuery/LocationHeatmapQuery.ts

@@ -0,0 +1,17 @@
+import { LocationWitnessPayloadSchema } from '../../Witnesses'
+
+export type LocationHeatmapQuerySchema = 'network.xyo.location.heatmap.query'
+export const locationHeatmapQuerySchema: LocationHeatmapQuerySchema = 'network.xyo.location.heatmap.query'
+
+export type LocationHeatmapAnswerSchema = 'network.xyo.location.heatmap.answer'
+export const locationHeatmapAnswerSchema: LocationHeatmapAnswerSchema = 'network.xyo.location.heatmap.answer'
+
+export type LocationHeatmapQuery = {
+  startTime?: string
+  stopTime?: string
+  schema: LocationWitnessPayloadSchema
+}
+
+export const isLocationHeatmapQuery = (query: Record<string, unknown>): query is LocationHeatmapQuery => {
+  return query && query?.schema === locationHeatmapQuerySchema
+}

package/src/Diviner/LocationDiviner/Queries/LocationHeatmapQuery/index.ts

@@ -0,0 +1,2 @@
+export * from './LocationHeatmapPointProperties'
+export * from './LocationHeatmapQuery'

package/src/Diviner/LocationDiviner/Queries/LocationQuadkeyHeatmapQuery/LocationQuadkeyHeatmapQuery.ts

@@ -0,0 +1,15 @@
+import { LocationWitnessPayloadSchema } from '../../Witnesses'
+
+export type LocationQuadkeyHeatmapQuerySchema = 'network.xyo.location.heatmap.quadkey.query'
+export const locationQuadkeyHeatmapQuerySchema: LocationQuadkeyHeatmapQuerySchema = 'network.xyo.location.heatmap.quadkey.query'
+export type LocationQuadkeyHeatmapAnswerSchema = 'network.xyo.location.heatmap.quadkey.answer'
+export const locationQuadkeyHeatmapAnswerSchema: LocationQuadkeyHeatmapAnswerSchema = 'network.xyo.location.heatmap.quadkey.answer'
+export type LocationQuadkeyHeatmapQuery = {
+  startTime?: string
+  stopTime?: string
+  schema: LocationWitnessPayloadSchema
+}
+
+export const isLocationQuadkeyHeatmapQuery = (query: Record<string, unknown>): query is LocationQuadkeyHeatmapQuery => {
+  return query && query?.schema === locationQuadkeyHeatmapQuerySchema
+}

package/src/Diviner/LocationDiviner/Queries/LocationQuadkeyHeatmapQuery/index.ts

@@ -0,0 +1 @@
+export * from './LocationQuadkeyHeatmapQuery'

package/src/Diviner/LocationDiviner/Queries/LocationQueryCreationRequest.ts

@@ -0,0 +1,21 @@
+import { XyoApiConfig } from '../../../models'
+import { LocationHeatmapQuery, LocationHeatmapQuerySchema } from './LocationHeatmapQuery'
+import { LocationQuadkeyHeatmapQuery, LocationQuadkeyHeatmapQuerySchema } from './LocationQuadkeyHeatmapQuery'
+import { LocationQuerySchema } from './LocationQuerySchema'
+import { LocationTimeRangeQuery, LocationTimeRangeQuerySchema } from './LocationTimeRangeQuery'
+
+export interface LocationQueryCreationRequest<TSchema extends LocationQuerySchema = LocationQuerySchema, TQuery extends Record<string, unknown> = Record<string, unknown>> {
+  sourceArchivist: XyoApiConfig
+  sourceArchive: string
+  resultArchivist: XyoApiConfig
+  resultArchive: string
+  schema: TSchema
+  query: TQuery
+}
+
+export type LocationTimeRangeQueryCreationRequest = LocationQueryCreationRequest<LocationTimeRangeQuerySchema, LocationTimeRangeQuery>
+export type LocationHeatmapQueryCreationRequest = LocationQueryCreationRequest<LocationHeatmapQuerySchema, LocationHeatmapQuery>
+
+export type LocationQuadkeyHeatmapQueryCreationRequest = LocationQueryCreationRequest<LocationQuadkeyHeatmapQuerySchema, LocationQuadkeyHeatmapQuery>
+
+export type SupportedLocationQueryCreationRequest = LocationTimeRangeQueryCreationRequest | LocationHeatmapQueryCreationRequest | LocationQuadkeyHeatmapQueryCreationRequest

package/src/Diviner/LocationDiviner/Queries/LocationQueryCreationResponse.ts

@@ -0,0 +1,5 @@
+import { LocationQueryCreationRequest } from './LocationQueryCreationRequest'
+
+export interface LocationQueryCreationResponse extends LocationQueryCreationRequest {
+  hash: string
+}

package/src/Diviner/LocationDiviner/Queries/LocationQuerySchema.ts

@@ -0,0 +1,15 @@
+import { LocationHeatmapQuerySchema } from './LocationHeatmapQuery'
+import { LocationQuadkeyHeatmapQuerySchema } from './LocationQuadkeyHeatmapQuery'
+import { LocationTimeRangeQuerySchema } from './LocationTimeRangeQuery'
+
+export type LocationQuerySchema = LocationQuadkeyHeatmapQuerySchema | LocationHeatmapQuerySchema | LocationTimeRangeQuerySchema
+
+const locationQuerySchemas: Record<LocationQuerySchema, true> = {
+  'network.xyo.location.heatmap.quadkey.query': true,
+  'network.xyo.location.heatmap.query': true,
+  'network.xyo.location.range.query': true,
+}
+
+export const isSupportedLocationQuerySchema = (schema: string): schema is LocationQuerySchema => {
+  return locationQuerySchemas[schema as LocationQuerySchema] || false
+}

package/src/Diviner/LocationDiviner/Queries/LocationTimeRangeQuery/LocationTimeRangePointProperties.ts

@@ -0,0 +1,8 @@
+import { LocationWitnessPayloadSchema } from '../../Witnesses'
+
+export interface LocationTimeRangePointProperties {
+  schema: LocationWitnessPayloadSchema
+  _archive: string
+  _client: string
+  _timestamp: number
+}

package/src/Diviner/LocationDiviner/Queries/LocationTimeRangeQuery/LocationTimeRangeQuery.ts

@@ -0,0 +1,18 @@
+import { LocationWitnessPayloadSchema } from '../../Witnesses'
+
+export type LocationTimeRangeQuerySchema = 'network.xyo.location.range.query'
+export const locationTimeRangeQuerySchema = 'network.xyo.location.range.query'
+
+export type LocationTimeRangeAnswerSchema = 'network.xyo.location.range.answer'
+export const locationTimeRangeAnswerSchema = 'network.xyo.location.range.answer'
+
+export type LocationTimeRangeQuery = {
+  startTime?: string
+  stopTime?: string
+  schema: LocationWitnessPayloadSchema
+  // TODO: Bounding rectangle, etc.
+}
+
+export const isLocationTimeRangeQuery = (query: Record<string, unknown>): query is LocationTimeRangeQuery => {
+  return query && query?.schema === locationTimeRangeQuerySchema
+}

package/src/Diviner/LocationDiviner/Queries/LocationTimeRangeQuery/index.ts

@@ -0,0 +1,2 @@
+export * from './LocationTimeRangePointProperties'
+export * from './LocationTimeRangeQuery'

package/src/Diviner/LocationDiviner/Queries/index.ts

@@ -0,0 +1,6 @@
+export * from './LocationHeatmapQuery'
+export * from './LocationQuadkeyHeatmapQuery'
+export * from './LocationQueryCreationRequest'
+export * from './LocationQueryCreationResponse'
+export * from './LocationQuerySchema'
+export * from './LocationTimeRangeQuery'

package/src/Diviner/LocationDiviner/Witnesses/CurrentLocationWitness.ts

@@ -0,0 +1,16 @@
+import { WithXyoPayloadMeta, XyoPayloadBody } from '@xyo-network/core'
+
+export const currentLocationWitnessPayloadSchema = 'co.coinapp.currentlocationwitness'
+export type CurrentLocationWitnessPayloadSchema = 'co.coinapp.currentlocationwitness'
+
+export interface CurrentLocationWitnessPayloadBody extends XyoPayloadBody {
+  altitudeMeters: number
+  directionDegrees: number
+  latitude: number
+  longitude: number
+  quadkey: string
+  schema: CurrentLocationWitnessPayloadSchema
+  speedKph: number
+}
+
+export declare type CurrentLocationWitnessPayload = WithXyoPayloadMeta<CurrentLocationWitnessPayloadBody>

package/src/Diviner/LocationDiviner/Witnesses/LocationWitness.ts

@@ -0,0 +1,25 @@
+import { WithXyoPayloadMeta, XyoPayloadBody } from '@xyo-network/core'
+
+export const locationWitnessPayloadSchema: LocationWitnessPayloadSchema = 'network.xyo.location'
+export type LocationWitnessPayloadSchema = 'network.xyo.location'
+
+export interface Coordinates {
+  accuracy: number | null
+  altitude: number | null
+  altitudeAccuracy: number | null
+  heading: number | null
+  latitude: number
+  longitude: number
+  speed: number | null
+}
+export interface CurrentLocation {
+  coords: Coordinates
+  timestamp: number
+}
+
+export interface LocationWitnessPayloadBody extends XyoPayloadBody {
+  currentLocation: CurrentLocation
+  schema: LocationWitnessPayloadSchema
+}
+
+export type LocationWitnessPayload = WithXyoPayloadMeta<LocationWitnessPayloadBody>

package/src/Diviner/LocationDiviner/Witnesses/index.ts

@@ -0,0 +1,2 @@
+export * from './CurrentLocationWitness'
+export * from './LocationWitness'

package/src/Diviner/LocationDiviner/index.ts

@@ -0,0 +1,4 @@
+export * from './LocationDivinerApi'
+export * from './models'
+export * from './Queries'
+export * from './Witnesses'

package/src/Diviner/LocationDiviner/models.ts

@@ -0,0 +1,4 @@
+export interface GetLocationQueryResponse {
+  queryHash: string
+  answerHash?: string
+}

package/src/Diviner/index.ts

@@ -0,0 +1 @@
+export * from './LocationDiviner'

package/src/Simple.ts

@@ -0,0 +1,69 @@
+import { XyoPayload } from '@xyo-network/core'
+
+import { XyoApiBase } from './Base'
+import { XyoApiConfig, XyoApiResponseBody, XyoApiResponseTuple, XyoApiResponseTupleOrBody, XyoApiResponseType } from './models'
+import { objToQuery } from './objToQuery'
+
+export type XyoApiSimpleQuery = Record<string, unknown>
+
+export class XyoApiSimple<T = XyoPayload, D = T, Q extends XyoApiSimpleQuery = Record<string, never>, C extends XyoApiConfig = XyoApiConfig> extends XyoApiBase<C> {
+  public async get(): Promise<XyoApiResponseBody<T>>
+  public async get(responseType?: 'body'): Promise<XyoApiResponseBody<T>>
+  public async get(responseType?: 'tuple'): Promise<XyoApiResponseTuple<T>>
+  public async get(responseType?: XyoApiResponseType): Promise<XyoApiResponseTupleOrBody<T>> {
+    switch (responseType) {
+      case 'tuple':
+        return await this.getEndpoint(undefined, 'tuple')
+      default:
+        return await this.getEndpoint(undefined)
+    }
+  }
+
+  public async find(query?: Q): Promise<XyoApiResponseBody<T>>
+  public async find(query?: Q, responseType?: 'body'): Promise<XyoApiResponseBody<T>>
+  public async find(query?: Q, responseType?: 'tuple'): Promise<XyoApiResponseTuple<T>>
+  public async find(query = {}, responseType?: XyoApiResponseType): Promise<XyoApiResponseTupleOrBody<T>> {
+    switch (responseType) {
+      case 'tuple':
+        return await this.getEndpoint(objToQuery(query), 'tuple')
+      default:
+        return await this.getEndpoint(objToQuery(query))
+    }
+  }
+
+  public async post(data?: D): Promise<XyoApiResponseBody<T>>
+  public async post(data?: D, responseType?: 'body'): Promise<XyoApiResponseBody<T>>
+  public async post(data?: D, responseType?: 'tuple'): Promise<XyoApiResponseTuple<T>>
+  public async post(data?: D, responseType?: XyoApiResponseType): Promise<XyoApiResponseTupleOrBody<T>> {
+    switch (responseType) {
+      case 'tuple':
+        return await this.postEndpoint(undefined, data, 'tuple')
+      default:
+        return await this.postEndpoint(undefined, data)
+    }
+  }
+
+  public async put(data?: D): Promise<XyoApiResponseBody<T>>
+  public async put(data?: D, responseType?: 'body'): Promise<XyoApiResponseBody<T>>
+  public async put(data?: D, responseType?: 'tuple'): Promise<XyoApiResponseTuple<T>>
+  public async put(data?: D, responseType?: XyoApiResponseType): Promise<XyoApiResponseTupleOrBody<T>> {
+    switch (responseType) {
+      case 'tuple':
+        return await this.putEndpoint(undefined, data, 'tuple')
+      default:
+        return await this.putEndpoint(undefined, data)
+    }
+  }
+
+  public async delete(): Promise<XyoApiResponseBody<T>>
+  public async delete(responseType?: 'body'): Promise<XyoApiResponseBody<T>>
+  public async delete(responseType?: 'tuple'): Promise<XyoApiResponseTuple<T>>
+  public async delete(responseType?: XyoApiResponseType): Promise<XyoApiResponseTupleOrBody<T>> {
+    switch (responseType) {
+      case 'tuple':
+        return await this.deleteEndpoint(undefined, 'tuple')
+      default:
+        return await this.deleteEndpoint(undefined)
+    }
+  }
+}

package/src/Test/index.ts

@@ -0,0 +1,2 @@
+export * from './testBoundWitness'
+export * from './testPayload'

package/src/Test/testBoundWitness.ts

@@ -0,0 +1,16 @@
+import { XyoBoundWitness } from '@xyo-network/core'
+
+const testBoundWitness: XyoBoundWitness = {
+  _archive: 'temp',
+  _client: 'js',
+  _hash: 'b0ffb9ebf872dc316b7be48327256c5316f7cb84d7c706861b18b86af1942dea',
+  _signatures: ['95100e5fd2012b958e96895870cfac5353c3a33a19314cfd1304ef7d01d052ec2a3ef80d6449cf88d463027fe0d868ed8cfb8b7323d37e93a08570233eea0b17'],
+  _timestamp: 1650067385598,
+  addresses: ['5346a2ce56ec4177b67092bda710e150ba6fa046'],
+  payload_hashes: ['20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c'],
+  payload_schemas: ['network.xyo.test'],
+  previous_hashes: [null],
+  schema: 'network.xyo.boundwitness',
+}
+
+export { testBoundWitness }

package/src/Test/testPayload.ts

@@ -0,0 +1,17 @@
+import { XyoPayload } from '@xyo-network/core'
+
+const testSchema = 'network.xyo.test'
+const testPayload: XyoPayload = {
+  _archive: 'test',
+  _hash: '20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c',
+  _timestamp: 1609459255555,
+  numberField: 1,
+  objectField: {
+    numberField: 1,
+    stringField: 'stringValue',
+  },
+  schema: testSchema,
+  stringField: 'stringValue',
+}
+
+export { testPayload, testSchema }

package/src/User/Api.spec.ts

@@ -0,0 +1,41 @@
+import { typeOf } from '@xyo-network/core'
+
+import { XyoArchivistApi } from '../Archivist'
+import { XyoApiConfig, XyoApiError } from '../models'
+import { XyoUserApi } from './Api'
+
+const timeout = 20000
+const config: XyoApiConfig = {
+  apiDomain: process.env.API_DOMAIN || 'http://localhost:8080',
+  jwtToken: process.env.JWT_TOKEN || undefined,
+}
+
+const describeSkipIfNoToken = config.jwtToken ? describe : describe.skip
+
+describe('XyoAuthApi', () => {
+  describe('get', () => {
+    it('returns a new XyoAuthApi', () => {
+      const api = new XyoUserApi(config)
+      expect(api).toBeDefined()
+    })
+  })
+
+  describeSkipIfNoToken('walletChallenge', function () {
+    it(
+      'returns a nonce',
+      async () => {
+        const api = new XyoArchivistApi(config)
+        try {
+          const response = await api.account('0xfEf40940e776A3686Cb29eC712d60859EA9f99F7').challenge.post()
+          expect(response?.state).toBeDefined()
+          expect(typeOf(response?.state)).toBe('string')
+        } catch (ex) {
+          const error = ex as XyoApiError
+          console.log(JSON.stringify(error.response?.data, null, 2))
+          throw ex
+        }
+      },
+      timeout
+    )
+  })
+})

package/src/User/Api.ts

@@ -0,0 +1,39 @@
+import { XyoApiBase } from '../Base'
+import { XyoApiSimple } from '../Simple'
+
+export interface XyoUserLogin {
+  /** @field Email address of the user [in] */
+  email?: string
+  /** @field Password of the user [in] */
+  password?: string
+  /** @field Token to access the API as that user [out] */
+  token?: string
+}
+
+export class XyoUserApi extends XyoApiBase {
+  public get authenticated() {
+    return !!this.config.jwtToken
+  }
+
+  public get headers(): Record<string, string> {
+    const headers: Record<string, string> = {}
+    if (this.config.jwtToken) {
+      headers.Authorization = `Bearer ${this.config.jwtToken}`
+    }
+    return headers
+  }
+
+  public get login() {
+    return new XyoApiSimple<XyoUserLogin>({
+      ...this.config,
+      root: `${this.root}login/`,
+    })
+  }
+
+  public get profile() {
+    return new XyoApiSimple({
+      ...this.config,
+      root: `${this.root}profile/`,
+    })
+  }
+}

package/src/User/index.ts

@@ -0,0 +1 @@
+export * from './Api'

package/src/WithArchive.ts

@@ -0,0 +1,3 @@
+export declare type WithArchive<XyoArchivistApiConfig> = XyoArchivistApiConfig & {
+  _archive?: string
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from './Archivist'
+export * from './Base'
+export * from './Diviner'
+export * from './models'
+export * from './Simple'
+export * from './User'
+export * from './WithArchive'

package/src/models/Api/Config.ts

@@ -0,0 +1,35 @@
+import { XyoApiReportable } from './Reportable'
+
+interface XyoApiConfig extends XyoApiReportable {
+  /** @description The domain where the api is located */
+  apiDomain: string
+
+  /** @deprecated use the jwtToken instead*/
+  userid?: string
+
+  /** @description The jwtToken of the currently logged in user */
+  jwtToken?: string
+
+  /** @description The apiKey used for authentication */
+  apiKey?: string
+
+  /** @description The location in the API tree where this API object is mounted */
+  root?: string
+
+  /** @description The query string, if any, that is added to the end of every request */
+  query?: string
+
+  /** @description Threshold for Content-Size to cause automatic gzip of request body [default = 1024] */
+  compressionThreshold?: number
+
+  /** @description Throw on failures */
+  throwFailure?: boolean
+
+  /** @description Throw on error */
+  throwError?: boolean
+
+  /** @description Parent that should also report events from this api */
+  reportableParent?: XyoApiReportable
+}
+
+export type { XyoApiConfig }

package/src/models/Api/Envelope.ts

@@ -0,0 +1,18 @@
+import { XyoApiError } from './Error'
+import { XyoApiWarning } from './Warning'
+
+export interface XyoApiEnvelopeBase {
+  warning?: XyoApiWarning[]
+}
+
+export interface XyoApiEnvelopeSuccess<T> extends XyoApiEnvelopeBase {
+  data: T
+  error: never
+}
+
+export interface XyoApiEnvelopeError extends XyoApiEnvelopeBase {
+  data: never
+  error: XyoApiError[]
+}
+
+export type XyoApiEnvelope<T> = XyoApiEnvelopeSuccess<T> | XyoApiEnvelopeError

package/src/models/Api/Error.ts

@@ -0,0 +1,6 @@
+import { AxiosError } from 'axios'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export interface XyoApiError<T = any, D = any> extends AxiosError<T, D> {
+  isXyoError: true
+}

package/src/models/Api/Reportable.ts

@@ -0,0 +1,10 @@
+import { XyoApiError } from './Error'
+import { XyoApiResponse } from './Response'
+
+export interface XyoApiReportable {
+  onError?: (error: XyoApiError, depth: number) => void
+
+  onFailure?: (response: XyoApiResponse, depth: number) => void
+
+  onSuccess?: (response: XyoApiResponse, depth: number) => void
+}

package/src/models/Api/Response.ts

@@ -0,0 +1,13 @@
+import { AxiosResponse } from 'axios'
+
+import { XyoApiEnvelope } from './Envelope'
+
+export type XyoApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>
+
+export type XyoApiResponseBody<T> = T | undefined
+
+export type XyoApiResponseTuple<T> = [T | undefined, XyoApiEnvelope<T | undefined>, XyoApiResponse<XyoApiEnvelope<T | undefined>>]
+
+export type XyoApiResponseTupleOrBody<T> = XyoApiResponseTuple<T> | XyoApiResponseBody<T>
+
+export type XyoApiResponseType = 'body' | 'tuple'

package/src/models/Api/Warning.ts

@@ -0,0 +1 @@
+export type XyoApiWarning = Error

package/src/models/Api/index.ts

@@ -0,0 +1,6 @@
+export * from './Config'
+export * from './Envelope'
+export * from './Error'
+export * from './Reportable'
+export * from './Response'
+export * from './Warning'

package/src/models/Archive.ts

@@ -0,0 +1,28 @@
+import { XyoArchivePath } from './ArchivePath'
+
+export type AccessLevel = 'public' | 'private' | 'none'
+export type AccessType = 'read' | 'remove' | 'create' | 'list'
+export type ExpirationWindow = 'create' | 'read'
+
+export interface XyoAccessControl {
+  access?: Record<AccessType, AccessLevel>
+  expiration?: {
+    window?: ExpirationWindow
+    delay?: number
+  }
+}
+
+export interface XyoAccessControls {
+  /**
+   * Set access controls on a per schema basis.
+   * '*' can be used as a wildcard
+   * Access control is set from a generic to specific direction if
+   * multiple wildcard versions apply to a schema
+   */
+  schema?: Record<string, XyoAccessControl>
+}
+
+export interface XyoArchive extends XyoArchivePath {
+  user?: string
+  accessControl?: XyoAccessControl | boolean
+}

package/src/models/ArchiveKey.ts

@@ -0,0 +1,5 @@
+export interface XyoArchiveKey {
+  archive: string
+  created?: number
+  key: string
+}

package/src/models/ArchivePath.ts

@@ -0,0 +1,3 @@
+export interface XyoArchivePath {
+  archive: string
+}

package/src/models/index.ts

@@ -0,0 +1,4 @@
+export * from './Api'
+export * from './Archive'
+export * from './ArchiveKey'
+export * from './ArchivePath'

package/src/objToQuery.ts

@@ -0,0 +1,8 @@
+export const objToQuery = (obj: Record<string, string | number | undefined>) => {
+  return `?${Object.entries(obj)
+    .map(([key, value]) => {
+      return `${key}=${value}`
+    })
+    .filter((value) => value !== undefined)
+    .join('&')}`
+}

package/typedoc.json

@@ -0,0 +1,10 @@
+{
+  "intentionallyNotExported": [
+    "WithXyoPayloadMeta",
+    "XyoPayload",
+    "XyoBoundWitness",
+    "XyoDataLike",
+    "Huri",
+    "XyoSchemaPayload"
+  ]
+}