@worknice/js-sdk 0.0.1

package/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2024 Worknice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# JS-SDK
+
+```bash
+pnpm install @worknice/js-sdk currency.js
+```

package/dist/_types-DsB4q143.d.ts

@@ -0,0 +1,127 @@
+import { Exact, Scalars, InputMaybe } from './api/_generated.js';
+
+declare const createWorkniceClient: (clientConfig?: ClientConfig) => {
+    fetchFromApi: <Data extends object, Variables extends object>(query: string, variables?: Variables, fetchOptions?: FetchOptions) => Promise<SuccessfulQueryResult<Data>>;
+    /**
+     * Transitions an integration with an 'UNAUTHORIZED' or 'UNCONFIGURED'
+     * status to an 'ACTIVE' status. Optionally, the name of the integration can
+     * be set at the same time.
+     */
+    activateIntegration: (variables: Pick<Exact<{
+        id: Scalars["ID"]["input"];
+        name?: InputMaybe<Scalars["String"]["input"]>;
+        rename: Scalars["Boolean"]["input"];
+    }>, "id" | "name">, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    }>;
+    /**
+     * Creates a new API token belonging to the current person.
+     */
+    createApiToken: (variables: Exact<{
+        name: Scalars["String"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        token: string;
+        id: string;
+        name: string;
+    }>;
+    /**
+     * Permanently deletes an API token belonging to the current person.
+     */
+    deleteApiToken: (variables: Exact<{
+        tokenId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<boolean>;
+    /**
+     * Transitions an integration with an 'UNINITIALIZED' status to an 'UNAUTHORIZED' status.
+     */
+    initializeIntegration: (variables: Exact<{
+        id: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    }>;
+    /**
+     * Returns a list of API tokens belonging to the current person. This will not
+     * include the token values themselves as they are only available when the
+     * token is initially created.
+     *
+     * If there is no person associated with the session, a `NO_PERSON` error will
+     * be thrown.
+     */
+    getApiTokens: (variables: Exact<{
+        [key: string]: never;
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        createdAt: string;
+        id: string;
+        name: string;
+    }[]>;
+};
+
+type SuccessfulQueryResult<Data extends object = object> = Readonly<{
+    data: Data;
+}> | Readonly<{
+    data: Data;
+    errors: ReadonlyArray<GraphQLFormattedError>;
+}>;
+type FailedQueryResult = Readonly<{
+    data: null;
+    errors: ReadonlyArray<GraphQLFormattedError>;
+}> | Readonly<{
+    errors: ReadonlyArray<GraphQLFormattedError>;
+}>;
+type QueryResult<Data extends object = object> = SuccessfulQueryResult<Data> | FailedQueryResult;
+type FetchOptions = {
+    signal?: AbortSignal;
+};
+type ClientConfig = {
+    accessToken?: string;
+    apiUrl?: string;
+};
+type WorkniceClient = ReturnType<typeof createWorkniceClient>;
+interface GraphQLFormattedError {
+    /**
+     * A short, human-readable summary of the problem that **SHOULD NOT** change
+     * from occurrence to occurrence of the problem, except for purposes of
+     * localization.
+     */
+    readonly message: string;
+    /**
+     * If an error can be associated to a particular point in the requested
+     * GraphQL document, it should contain a list of locations.
+     */
+    readonly locations?: ReadonlyArray<SourceLocation>;
+    /**
+     * If an error can be associated to a particular field in the GraphQL result,
+     * it _must_ contain an entry with the key `path` that details the path of
+     * the response field which experienced the error. This allows clients to
+     * identify whether a null result is intentional or caused by a runtime error.
+     */
+    readonly path?: ReadonlyArray<string | number>;
+    /**
+     * Reserved for implementors to extend the protocol however they see fit,
+     * and hence there are no additional restrictions on its contents.
+     */
+    readonly extensions?: {
+        [key: string]: unknown;
+    };
+}
+interface SourceLocation {
+    readonly line: number;
+    readonly column: number;
+}
+
+export { type ClientConfig as C, type FetchOptions as F, type QueryResult as Q, type SuccessfulQueryResult as S, type WorkniceClient as W, type FailedQueryResult as a, createWorkniceClient as c };

package/dist/api/ApiError.d.ts

@@ -0,0 +1,12 @@
+declare class ApiError extends Error {
+    readonly code: ApiErrorCode;
+    constructor(code: ApiErrorCode, options?: ErrorOptions);
+}
+declare enum ApiErrorCode {
+    INVALID_QUERY = "INVALID_QUERY",
+    NO_PERSON = "NO_PERSON",
+    QUERY_EXECUTION_FAILED = "QUERY_EXECUTION_FAILED",
+    UNEXPECTED_RESPONSE = "UNEXPECTED_RESPONSE"
+}
+
+export { ApiErrorCode, ApiError as default };

package/dist/api/ApiError.js

@@ -0,0 +1,27 @@
+class ApiError extends Error {
+  code;
+  constructor(code, options) {
+    super(ApiErrorCodeMessage[code], options);
+    this.name = "ApiError";
+    this.code = code;
+  }
+}
+var ApiErrorCode = /* @__PURE__ */ ((ApiErrorCode2) => {
+  ApiErrorCode2["INVALID_QUERY"] = "INVALID_QUERY";
+  ApiErrorCode2["NO_PERSON"] = "NO_PERSON";
+  ApiErrorCode2["QUERY_EXECUTION_FAILED"] = "QUERY_EXECUTION_FAILED";
+  ApiErrorCode2["UNEXPECTED_RESPONSE"] = "UNEXPECTED_RESPONSE";
+  return ApiErrorCode2;
+})(ApiErrorCode || {});
+const ApiErrorCodeMessage = {
+  ["INVALID_QUERY" /* INVALID_QUERY */]: "The GraphQL query could not be executed due to a syntax error, missing information or a validation error.",
+  ["NO_PERSON" /* NO_PERSON */]: "No person associated with the session. The session is either in an 'unauthenticated' state (the API token is missing or invalid) or an 'unassociated' state (the user has no active logins).",
+  ["QUERY_EXECUTION_FAILED" /* QUERY_EXECUTION_FAILED */]: "An error occurred while executing the GraphQL query. This is likely a problem with the Worknice API.",
+  ["UNEXPECTED_RESPONSE" /* UNEXPECTED_RESPONSE */]: "The API returned an unexpected response. This is likely a problem with the Worknice API or a mismatch between JS-SDK and the API. Make sure you are using the latest version of the JS-SDK."
+};
+var ApiError_default = ApiError;
+export {
+  ApiErrorCode,
+  ApiError_default as default
+};
+//# sourceMappingURL=ApiError.js.map

package/dist/api/ApiError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/api/ApiError.ts"],"sourcesContent":["class ApiError extends Error {\n  readonly code: ApiErrorCode;\n  constructor(code: ApiErrorCode, options?: ErrorOptions) {\n    super(ApiErrorCodeMessage[code], options);\n    this.name = \"ApiError\";\n    this.code = code;\n  }\n}\n\nenum ApiErrorCode {\n  INVALID_QUERY = \"INVALID_QUERY\",\n  NO_PERSON = \"NO_PERSON\",\n  QUERY_EXECUTION_FAILED = \"QUERY_EXECUTION_FAILED\",\n  UNEXPECTED_RESPONSE = \"UNEXPECTED_RESPONSE\",\n}\n\nconst ApiErrorCodeMessage: Record<ApiErrorCode, string> = {\n  [ApiErrorCode.INVALID_QUERY]:\n    \"The GraphQL query could not be executed due to a syntax error, missing information or a validation error.\",\n  [ApiErrorCode.NO_PERSON]:\n    \"No person associated with the session. The session is either in an 'unauthenticated' state (the API token is missing or invalid) or an 'unassociated' state (the user has no active logins).\",\n  [ApiErrorCode.QUERY_EXECUTION_FAILED]:\n    \"An error occurred while executing the GraphQL query. This is likely a problem with the Worknice API.\",\n  [ApiErrorCode.UNEXPECTED_RESPONSE]:\n    \"The API returned an unexpected response. This is likely a problem with the Worknice API or a mismatch between JS-SDK and the API. Make sure you are using the latest version of the JS-SDK.\",\n} as const;\n\nexport default ApiError;\nexport { ApiErrorCode };\n"],"mappings":"AAAA,MAAM,iBAAiB,MAAM;AAAA,EAClB;AAAA,EACT,YAAY,MAAoB,SAAwB;AACtD,UAAM,oBAAoB,IAAI,GAAG,OAAO;AACxC,SAAK,OAAO;AACZ,SAAK,OAAO;AAAA,EACd;AACF;AAEA,IAAK,eAAL,kBAAKA,kBAAL;AACE,EAAAA,cAAA,mBAAgB;AAChB,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,4BAAyB;AACzB,EAAAA,cAAA,yBAAsB;AAJnB,SAAAA;AAAA,GAAA;AAOL,MAAM,sBAAoD;AAAA,EACxD,CAAC,mCAA0B,GACzB;AAAA,EACF,CAAC,2BAAsB,GACrB;AAAA,EACF,CAAC,qDAAmC,GAClC;AAAA,EACF,CAAC,+CAAgC,GAC/B;AACJ;AAEA,IAAO,mBAAQ;","names":["ApiErrorCode"]}