@coveo/push-api-client 1.0.0 → 1.1.4

package/README.md

@@ -1,4 +1,43 @@
 # @coveo/push-api-client.js
-Push API client
 
-Work in progress
+Coveo Push API client
+
+## Installation
+
+`npm i @coveo/push-api-client`
+
+## Usage
+
+```js
+import {Source, DocumentBuilder} from '@coveo/push-api-client';
+
+async function main() {
+  const source = new Source('my_api_key', 'my_coveo_organization_id');
+
+  const myDocument = new DocumentBuilder(
+    'https://my.document.uri',
+    'My document title'
+  ).withData('these words will be searchable');
+
+  await source.addOrUpdateDocument('my_source_id', myDocument);
+}
+
+main();
+```
+
+See more examples in the `./samples` folder.
+
+## Local development
+
+- `npm i`
+- Copy `env.sample` to `.env`, and replace the variables with proper values.
+- `npm run dev` to compile and run `./src/localtest.ts`.
+- `npm run test` for unit tests.
+
+## Commit
+
+Use `npm run commit` to get a properly formatted commit message which will help control the versioning and CHANGELOG generation.
+
+## Release
+
+Run Github action named `release`, which will bump version, tag and publish to npm.

package/dist/definitions/document.d.ts

@@ -27,7 +27,7 @@ export interface SecurityIdentity {
      */
     securityProvider?: string;
 }
-export declare type MetadataValue = string | string[] | number | number[];
+export declare type MetadataValue = string | string[] | number | number[] | boolean;
 export declare type Metadata = Record<string, MetadataValue>;
 /**
  * The compression type that was applied to your compressed document.

package/dist/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/dist/docs/assets/highlight.css

@@ -0,0 +1,71 @@
+:root {
+    --light-hl-0: #AF00DB;
+    --dark-hl-0: #C586C0;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #A31515;
+    --dark-hl-3: #CE9178;
+    --light-hl-4: #0000FF;
+    --dark-hl-4: #569CD6;
+    --light-hl-5: #795E26;
+    --dark-hl-5: #DCDCAA;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --code-background: var(--dark-code-background);
+} }
+
+body.light {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --code-background: var(--light-code-background);
+}
+
+body.dark {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+pre, code { background: var(--code-background); }