@distilled.cloud/typesense 0.0.0 → 0.15.0

package/src/operations/getCollections.ts

@@ -0,0 +1,82 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { SensitiveString } from "../sensitive.ts";
+
+// Input Schema
+export const GetCollectionsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  getCollectionsParameters: Schema.optional(Schema.String),
+}).pipe(T.Http({ method: "GET", path: "/collections" }));
+export type GetCollectionsInput = typeof GetCollectionsInput.Type;
+
+// Output Schema
+export const GetCollectionsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    name: Schema.String,
+    fields: Schema.Array(
+      Schema.Struct({
+        name: Schema.String,
+        type: Schema.String,
+        optional: Schema.optional(Schema.Boolean),
+        facet: Schema.optional(Schema.Boolean),
+        index: Schema.optional(Schema.Boolean),
+        locale: Schema.optional(Schema.String),
+        sort: Schema.optional(Schema.Boolean),
+        infix: Schema.optional(Schema.Boolean),
+        reference: Schema.optional(Schema.String),
+        async_reference: Schema.optional(Schema.Boolean),
+        num_dim: Schema.optional(Schema.Number),
+        drop: Schema.optional(Schema.Boolean),
+        store: Schema.optional(Schema.Boolean),
+        vec_dist: Schema.optional(Schema.String),
+        range_index: Schema.optional(Schema.Boolean),
+        stem: Schema.optional(Schema.Boolean),
+        stem_dictionary: Schema.optional(Schema.String),
+        token_separators: Schema.optional(Schema.Array(Schema.String)),
+        symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
+        embed: Schema.optional(
+          Schema.Struct({
+            from: Schema.Array(Schema.String),
+            model_config: Schema.Struct({
+              model_name: Schema.String,
+              api_key: Schema.optional(SensitiveString),
+              url: Schema.optional(Schema.String),
+              access_token: Schema.optional(SensitiveString),
+              refresh_token: Schema.optional(SensitiveString),
+              client_id: Schema.optional(Schema.String),
+              client_secret: Schema.optional(SensitiveString),
+              project_id: Schema.optional(Schema.String),
+              indexing_prefix: Schema.optional(Schema.String),
+              query_prefix: Schema.optional(Schema.String),
+            }),
+          }),
+        ),
+      }),
+    ),
+    default_sorting_field: Schema.optional(Schema.String),
+    token_separators: Schema.optional(Schema.Array(Schema.String)),
+    synonym_sets: Schema.optional(Schema.Array(Schema.String)),
+    enable_nested_fields: Schema.optional(Schema.Boolean),
+    symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
+    voice_query_model: Schema.optional(
+      Schema.Struct({
+        model_name: Schema.optional(Schema.String),
+      }),
+    ),
+    metadata: Schema.optional(Schema.Unknown),
+    num_documents: Schema.Number,
+    created_at: Schema.Number,
+  }),
+);
+export type GetCollectionsOutput = typeof GetCollectionsOutput.Type;
+
+// The operation
+/**
+ * List all collections
+ *
+ * Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.
+ */
+export const getCollections = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetCollectionsInput,
+  outputSchema: GetCollectionsOutput,
+}));

package/src/operations/getDocument.ts

@@ -0,0 +1,35 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const GetDocumentInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  collectionName: Schema.String.pipe(T.PathParam()),
+  documentId: Schema.String.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/collections/{collectionName}/documents/{documentId}",
+  }),
+);
+export type GetDocumentInput = typeof GetDocumentInput.Type;
+
+// Output Schema
+export const GetDocumentOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Unknown;
+export type GetDocumentOutput = typeof GetDocumentOutput.Type;
+
+// The operation
+/**
+ * Retrieve a document
+ *
+ * Fetch an individual document from a collection by using its ID.
+ *
+ * @param collectionName - The name of the collection to search for the document under
+ * @param documentId - The Document ID
+ */
+export const getDocument = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetDocumentInput,
+  outputSchema: GetDocumentOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/getKey.ts

@@ -0,0 +1,36 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const GetKeyInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  keyId: Schema.Number.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/keys/{keyId}" }));
+export type GetKeyInput = typeof GetKeyInput.Type;
+
+// Output Schema
+export const GetKeyOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  value: Schema.optional(Schema.String),
+  description: Schema.String,
+  actions: Schema.Array(Schema.String),
+  collections: Schema.Array(Schema.String),
+  expires_at: Schema.optional(Schema.Number),
+  id: Schema.optional(Schema.Number),
+  value_prefix: Schema.optional(Schema.String),
+});
+export type GetKeyOutput = typeof GetKeyOutput.Type;
+
+// The operation
+/**
+ * Retrieve (metadata about) a key
+ *
+ * Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key.
+ *
+ * @param keyId - The ID of the key to retrieve
+ */
+export const getKey = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetKeyInput,
+  outputSchema: GetKeyOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/getKeys.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const GetKeysInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+  T.Http({ method: "GET", path: "/keys" }),
+);
+export type GetKeysInput = typeof GetKeysInput.Type;
+
+// Output Schema
+export const GetKeysOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  keys: Schema.Array(
+    Schema.Struct({
+      value: Schema.optional(Schema.String),
+      description: Schema.String,
+      actions: Schema.Array(Schema.String),
+      collections: Schema.Array(Schema.String),
+      expires_at: Schema.optional(Schema.Number),
+      id: Schema.optional(Schema.Number),
+      value_prefix: Schema.optional(Schema.String),
+    }),
+  ),
+});
+export type GetKeysOutput = typeof GetKeysOutput.Type;
+
+// The operation
+/**
+ * Retrieve (metadata about) all keys.
+ */
+export const getKeys = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetKeysInput,
+  outputSchema: GetKeysOutput,
+}));

package/src/operations/getSchemaChanges.ts

@@ -0,0 +1,30 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const GetSchemaChangesInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {},
+).pipe(T.Http({ method: "GET", path: "/operations/schema_changes" }));
+export type GetSchemaChangesInput = typeof GetSchemaChangesInput.Type;
+
+// Output Schema
+export const GetSchemaChangesOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    collection: Schema.optional(Schema.String),
+    validated_docs: Schema.optional(Schema.Number),
+    altered_docs: Schema.optional(Schema.Number),
+  }),
+);
+export type GetSchemaChangesOutput = typeof GetSchemaChangesOutput.Type;
+
+// The operation
+/**
+ * Get the status of in-progress schema change operations
+ *
+ * Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response.
+ */
+export const getSchemaChanges = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetSchemaChangesInput,
+  outputSchema: GetSchemaChangesOutput,
+}));

package/src/operations/getStemmingDictionary.ts

@@ -0,0 +1,43 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const GetStemmingDictionaryInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    dictionaryId: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({ method: "GET", path: "/stemming/dictionaries/{dictionaryId}" }),
+  );
+export type GetStemmingDictionaryInput = typeof GetStemmingDictionaryInput.Type;
+
+// Output Schema
+export const GetStemmingDictionaryOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    words: Schema.Array(
+      Schema.Struct({
+        word: Schema.String,
+        root: Schema.String,
+      }),
+    ),
+  });
+export type GetStemmingDictionaryOutput =
+  typeof GetStemmingDictionaryOutput.Type;
+
+// The operation
+/**
+ * Retrieve a stemming dictionary
+ *
+ * Fetch details of a specific stemming dictionary.
+ *
+ * @param dictionaryId - The ID of the dictionary to retrieve
+ */
+export const getStemmingDictionary = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetStemmingDictionaryInput,
+    outputSchema: GetStemmingDictionaryOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/health.ts

@@ -0,0 +1,24 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const HealthInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+  T.Http({ method: "GET", path: "/health" }),
+);
+export type HealthInput = typeof HealthInput.Type;
+
+// Output Schema
+export const HealthOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  ok: Schema.Boolean,
+});
+export type HealthOutput = typeof HealthOutput.Type;
+
+// The operation
+/**
+ * Checks if Typesense server is ready to accept requests.
+ */
+export const health = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: HealthInput,
+  outputSchema: HealthOutput,
+}));

package/src/operations/importDocuments.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { BadRequest, NotFound } from "../errors.ts";
+
+// Input Schema
+export const ImportDocumentsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  collectionName: Schema.String.pipe(T.PathParam()),
+  importDocumentsParameters: Schema.optional(Schema.String),
+}).pipe(
+  T.Http({
+    method: "POST",
+    path: "/collections/{collectionName}/documents/import",
+  }),
+);
+export type ImportDocumentsInput = typeof ImportDocumentsInput.Type;
+
+// Output Schema
+export const ImportDocumentsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type ImportDocumentsOutput = typeof ImportDocumentsOutput.Type;
+
+// The operation
+/**
+ * Import documents into a collection
+ *
+ * The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.
+ *
+ * @param collectionName - The name of the collection
+ */
+export const importDocuments = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ImportDocumentsInput,
+  outputSchema: ImportDocumentsOutput,
+  errors: [BadRequest, NotFound] as const,
+}));

package/src/operations/importStemmingDictionary.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { BadRequest } from "../errors.ts";
+
+// Input Schema
+export const ImportStemmingDictionaryInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+  }).pipe(T.Http({ method: "POST", path: "/stemming/dictionaries/import" }));
+export type ImportStemmingDictionaryInput =
+  typeof ImportStemmingDictionaryInput.Type;
+
+// Output Schema
+export const ImportStemmingDictionaryOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type ImportStemmingDictionaryOutput =
+  typeof ImportStemmingDictionaryOutput.Type;
+
+// The operation
+/**
+ * Import a stemming dictionary
+ *
+ * Upload a JSONL file containing word mappings to create or update a stemming dictionary.
+ *
+ * @param id - The ID to assign to the dictionary
+ */
+export const importStemmingDictionary = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ImportStemmingDictionaryInput,
+    outputSchema: ImportStemmingDictionaryOutput,
+    errors: [BadRequest] as const,
+  }),
+);

package/src/operations/index.ts

@@ -0,0 +1,79 @@
+export * from "./getCollections.ts";
+export * from "./createCollection.ts";
+export * from "./getCollection.ts";
+export * from "./updateCollection.ts";
+export * from "./deleteCollection.ts";
+export * from "./indexDocument.ts";
+export * from "./updateDocuments.ts";
+export * from "./deleteDocuments.ts";
+export * from "./searchCollection.ts";
+export * from "./retrieveSynonymSets.ts";
+export * from "./retrieveSynonymSet.ts";
+export * from "./upsertSynonymSet.ts";
+export * from "./deleteSynonymSet.ts";
+export * from "./retrieveSynonymSetItems.ts";
+export * from "./retrieveSynonymSetItem.ts";
+export * from "./upsertSynonymSetItem.ts";
+export * from "./deleteSynonymSetItem.ts";
+export * from "./retrieveCurationSets.ts";
+export * from "./retrieveCurationSet.ts";
+export * from "./upsertCurationSet.ts";
+export * from "./deleteCurationSet.ts";
+export * from "./retrieveCurationSetItems.ts";
+export * from "./retrieveCurationSetItem.ts";
+export * from "./upsertCurationSetItem.ts";
+export * from "./deleteCurationSetItem.ts";
+export * from "./exportDocuments.ts";
+export * from "./importDocuments.ts";
+export * from "./getDocument.ts";
+export * from "./updateDocument.ts";
+export * from "./deleteDocument.ts";
+export * from "./retrieveAllConversationModels.ts";
+export * from "./createConversationModel.ts";
+export * from "./retrieveConversationModel.ts";
+export * from "./updateConversationModel.ts";
+export * from "./deleteConversationModel.ts";
+export * from "./getKeys.ts";
+export * from "./createKey.ts";
+export * from "./getKey.ts";
+export * from "./deleteKey.ts";
+export * from "./getAliases.ts";
+export * from "./getAlias.ts";
+export * from "./upsertAlias.ts";
+export * from "./deleteAlias.ts";
+export * from "./debug.ts";
+export * from "./health.ts";
+export * from "./getSchemaChanges.ts";
+export * from "./takeSnapshot.ts";
+export * from "./vote.ts";
+export * from "./clearCache.ts";
+export * from "./compactDb.ts";
+export * from "./toggleSlowRequestLog.ts";
+export * from "./multiSearch.ts";
+export * from "./getAnalyticsEvents.ts";
+export * from "./createAnalyticsEvent.ts";
+export * from "./flushAnalytics.ts";
+export * from "./getAnalyticsStatus.ts";
+export * from "./retrieveAnalyticsRules.ts";
+export * from "./createAnalyticsRule.ts";
+export * from "./retrieveAnalyticsRule.ts";
+export * from "./upsertAnalyticsRule.ts";
+export * from "./deleteAnalyticsRule.ts";
+export * from "./retrieveMetrics.ts";
+export * from "./retrieveAPIStats.ts";
+export * from "./retrieveStopwordsSets.ts";
+export * from "./retrieveStopwordsSet.ts";
+export * from "./upsertStopwordsSet.ts";
+export * from "./deleteStopwordsSet.ts";
+export * from "./retrieveAllPresets.ts";
+export * from "./retrievePreset.ts";
+export * from "./upsertPreset.ts";
+export * from "./deletePreset.ts";
+export * from "./listStemmingDictionaries.ts";
+export * from "./getStemmingDictionary.ts";
+export * from "./importStemmingDictionary.ts";
+export * from "./retrieveAllNLSearchModels.ts";
+export * from "./createNLSearchModel.ts";
+export * from "./retrieveNLSearchModel.ts";
+export * from "./updateNLSearchModel.ts";
+export * from "./deleteNLSearchModel.ts";

package/src/operations/indexDocument.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const IndexDocumentInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  collectionName: Schema.String.pipe(T.PathParam()),
+  action: Schema.optional(Schema.String),
+  dirty_values: Schema.optional(Schema.String),
+}).pipe(
+  T.Http({ method: "POST", path: "/collections/{collectionName}/documents" }),
+);
+export type IndexDocumentInput = typeof IndexDocumentInput.Type;
+
+// Output Schema
+export const IndexDocumentOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Unknown;
+export type IndexDocumentOutput = typeof IndexDocumentOutput.Type;
+
+// The operation
+/**
+ * Index a document
+ *
+ * A document to be indexed in a given collection must conform to the schema of the collection.
+ *
+ * @param collectionName - The name of the collection to add the document to
+ * @param action - Additional action to perform
+ * @param dirty_values - Dealing with Dirty Data
+ */
+export const indexDocument = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: IndexDocumentInput,
+  outputSchema: IndexDocumentOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/listStemmingDictionaries.ts

@@ -0,0 +1,32 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const ListStemmingDictionariesInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+    T.Http({ method: "GET", path: "/stemming/dictionaries" }),
+  );
+export type ListStemmingDictionariesInput =
+  typeof ListStemmingDictionariesInput.Type;
+
+// Output Schema
+export const ListStemmingDictionariesOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    dictionaries: Schema.optional(Schema.Array(Schema.String)),
+  });
+export type ListStemmingDictionariesOutput =
+  typeof ListStemmingDictionariesOutput.Type;
+
+// The operation
+/**
+ * List all stemming dictionaries
+ *
+ * Retrieve a list of all available stemming dictionaries.
+ */
+export const listStemmingDictionaries = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ListStemmingDictionariesInput,
+    outputSchema: ListStemmingDictionariesOutput,
+  }),
+);