@extrahorizon/javascript-sdk 8.2.0-test

package/build/types/services/users/users.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { UsersService } from './types';
+declare const _default: (userClient: HttpClient, httpWithAuth: HttpInstance, http: HttpInstance) => UsersService;
+export default _default;

package/build/types/sha1.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copied from https://github.com/pH200/hmacsha1-js/blob/master/index.js
+ */
+/**
+ * Computes a HMAC-SHA1 code.
+ *
+ * @param {string} k Secret key.
+ * @param {string} d Data to be hashed.
+ * @return {string} The hashed string.
+ */
+export declare function HmacSHA1(k: any, d: any, _p?: any, _z?: any): string;

package/build/types/types.d.ts

@@ -0,0 +1,102 @@
+import { AxiosResponse } from 'axios';
+import { TokenDataOauth2, HttpRequestConfig } from './http/types';
+export * from './http/types';
+export * from './services/types';
+export * from './services/auth/types';
+export * from './services/data/types';
+export * from './services/files/types';
+export * from './services/tasks/types';
+export * from './services/users/types';
+export * from './services/mails/types';
+export * from './services/templates/types';
+export * from './services/configurations/types';
+export * from './services/dispatchers/types';
+export * from './services/payments/types';
+export * from './services/localizations/types';
+export * from './services/profiles/types';
+export * from './services/notifications/types';
+export * from './services/events/types';
+export interface ParamsOauth1WithEmail {
+    email: string;
+    password: string;
+}
+export interface ParamsOauth1WithToken {
+    token: string;
+    tokenSecret: string;
+    skipTokenCheck?: boolean;
+}
+export interface ParamsOauth2AuthorizationCode {
+    code: string;
+}
+export interface ParamsOauth2Password {
+    username: string;
+    password: string;
+}
+export interface ParamsOauth2Refresh {
+    refreshToken: string;
+}
+export declare type Oauth1AuthParams = ParamsOauth1WithEmail | ParamsOauth1WithToken;
+export declare type Oauth2AuthParams = ParamsOauth2AuthorizationCode | ParamsOauth2Password | ParamsOauth2Refresh;
+export declare type AuthParams = Oauth1AuthParams | Oauth2AuthParams;
+interface ParamsBase {
+    host: string;
+    responseLogger?: (response: AxiosResponse | Error) => unknown;
+    requestLogger?: (request: HttpRequestConfig | Error) => unknown;
+    headers?: {
+        'X-Request-Service'?: string;
+        'X-Forwarded-Application'?: string;
+        'X-Forwarded-User'?: string;
+    };
+    /**
+     * @deprecated this property is only meant to be used for backwards compatibility when upgrading to v8.0.0.
+     *
+     * Key names that are not chosen by Extra Horizon where also affected by the data normalization before v8.0.0.
+     * They were converted from camel case to snake case before sending the request and the other way around before
+     * providing the response.
+     *
+     * Also fields ending with the name timestamp not chosen by extra horizon in custom properties where automatically
+     * converted to dates. Even though they could be just booleans, strings or numbers. Dates provided in such fields will
+     * now be converted to strings while all other types will stay as they are.
+     *
+     * 'records_affected', 'recordsAffected' as keys in custom properties were converted to affectedRecords. In v8.0.0
+     * they also stay as they are.
+     *
+     * To enable this behaviour again, set to true.
+     */
+    normalizeCustomData?: boolean;
+}
+export interface ParamsOauth1Consumer extends ParamsBase {
+    consumerKey: string;
+    consumerSecret: string;
+}
+export interface ParamsOauth1Token extends ParamsOauth1Consumer {
+    token: string;
+    tokenSecret: string;
+}
+export declare type ParamsOauth1 = ParamsOauth1Consumer | ParamsOauth1Token;
+export interface ParamsOauth2Client extends ParamsBase {
+    clientId: string;
+    clientSecret?: string;
+    freshTokensCallback?: (tokenData: TokenDataOauth2) => void;
+}
+export interface ParamsOauth2AccessToken extends ParamsOauth2Client {
+    refreshToken: string;
+    accessToken: string;
+    /**
+     * Can be supplied just as it is returned by the different authentication methods and the `freshTokensCallback`.
+     * Allows the SDK to continue using the supplied access token until just before it expires, then it is automatically refreshed.
+     */
+    expiresIn?: number;
+    /**
+     * Can be supplied just as it is returned by the different authentication methods and the `freshTokensCallback`.
+     * Allows the SDK to continue using the supplied access token until just before it expires, then it is automatically refreshed.
+     */
+    creationTimestamp?: Date | string;
+}
+export declare type ParamsOauth2 = ParamsOauth2Client | ParamsOauth2AccessToken;
+export declare type ParamsProxy = ParamsBase;
+interface HttpClientBase {
+    packageVersion: string;
+}
+export declare type ClientParams = ParamsOauth1 | ParamsOauth2 | ParamsProxy;
+export declare type HttpClientConfig = HttpClientBase & ClientParams;

package/build/types/utils.d.ts

@@ -0,0 +1,4 @@
+import { ClientParams, GlobalPermissionName } from './types';
+export declare function validateConfig<T extends ClientParams>(params: T): T;
+export declare function delay(ms: number): Promise<void>;
+export declare function parseGlobalPermissions(permissions: string[]): GlobalPermissionName[];

package/build/types/version.d.ts

@@ -0,0 +1 @@
+export declare const version = "8.2.0-test";

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@extrahorizon/javascript-sdk",
+  "version": "8.2.0-test",
+  "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
+  "main": "build/index.cjs.js",
+  "types": "build/types/index.d.ts",
+  "module": "build/index.mjs",
+  "author": "Qompium",
+  "license": "MIT",
+  "scripts": {
+    "clean": "rimraf build",
+    "start": "yarn test",
+    "start:watch": "yarn test --watch --reporters=\"default\"",
+    "create-version-file": "node -e \"require('fs').promises.writeFile('src/version.ts', 'export const version = \\'' + require('./package.json').version + '\\';\\n')\"",
+    "create-mock-sdk": "node generateMockTypes.js > src/mockType.ts",
+    "build": "yarn create-version-file && yarn clean && yarn build:library && yarn create-mock-sdk && yarn build:declarations",
+    "build:library": "rollup --config rollup.config.js",
+    "build:declarations": "tsc --project tsconfig.declarations.json",
+    "watch": "yarn create-version-file && rollup --config rollup.config.js -w",
+    "watch:declarations": "tsc -w --project tsconfig.declarations.json",
+    "prepare": "yarn build && yarn lint",
+    "test": "jest",
+    "test:e2e": "jest tests/e2e",
+    "lint": "eslint src --ext .ts"
+  },
+  "files": [
+    "build"
+  ],
+  "dependencies": {
+    "axios": "0.28.1",
+    "buffer": "6.0.3",
+    "fflate": "0.8.2",
+    "form-data": "4.0.0",
+    "platform-specific": "1.1.0",
+    "qs": "6.12.0",
+    "typescript-json-decoder": "1.0.11"
+  },
+  "devDependencies": {
+    "@extrahorizon/eslint-config-node": "^1.6.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-typescript": "^8.3.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^17.0.21",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "nock": "^13.5.4",
+    "rimraf": "^5.0.5",
+    "rollup": "^2.68.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "ts-jest": "^29.1.2",
+    "typescript": "^4.5.5"
+  }
+}