@hw-agconnect/cloud-server 1.0.1

package/README.md

@@ -0,0 +1,258 @@
+# AppGallery Connect Cloud Server SDK for NodeJS
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Prerequisites](#prerequisites)
+- [Usage](#usage)
+    - [Initializing the SDK](#initializing-the-sdk)
+    - [Auth Service](#auth-service)
+    - [Cloud Functions](#cloud-functions)
+    - [Cloud DB](#cloud-db)
+        - [Initializing Cloud DB](#initializing-cloud-db)
+        - [Writing Data](#writing-data)
+        - [Querying Data](#querying-data)
+    - [Cloud Storage](#cloud-storage)
+- [Constraints and Limitations](#constraints-and-limitations)
+- [License](#license)
+
+## Introduction
+
+AppGallery Connect provides in-depth support for application development. The platform offers variety of cloud services which supports mainstream application platforms and helps developers quickly and efficiently build applications.
+
+The AGC Cloud-Server NodeJS SDK allows developers to access the AGC services from their server-side applications developed with NodeJS.
+
+SDK Provides support for multiple AGC cloud services:
+* Authentication service: helps applications quickly build a secure and reliable user authentication system.
+* Cloud function: provides a serverless code development and running platform.
+* Cloud database: Provides collaborative management of device-cloud data.
+* Cloud storage: helps applications store images, audios, and videos, and provides high-quality upload, download, and sharing capabilities.
+
+[Learn More (ZH)](https://developer.huawei.com/consumer/cn/doc/development/AppGallery-connect-Guides/agc-serverless-overview-0000001509965245)
+
+[Learn More (EN)](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-introduction-0000001057492641)
+
+## Installation
+
+```bash
+npm install @hw-agconnect/cloud-server
+```
+
+## Prerequisites
+
+
+Ensure that:
+
+- You have [installed Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on your development environment.
+- You have registered an account on the [HUAWEI Developer](https://developer.huawei.com/consumer/en/) website and passed real-name authentication. For details, see [HUAWEI ID Registration](https://developer.huawei.com/consumer/en/doc/start/registration-and-verification-0000001053628148).
+- You have created a project and app on the [AppGallery Connect console](https://developer.huawei.com/consumer/en/console). For details, see [Creating Your Project and App](https://developer.huawei.com/consumer/en/doc/distribution/app/agc-help-createproject-0000001100334664).
+- [Create an API Client in AGC Console](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-get-started-server-0000001058092593#section1778162811430) and download your project credentials.
+
+## Usage
+
+### Initializing the SDK
+
+Follow the steps below to initialize the Cloud-Server SDK in your application.
+
+```typescript
+import { cloud } from '@hw-agconnect/cloud-server';
+```
+
+
+- Method 1: Set the environment variable.
+    - On Linux, perform as follows:
+      For a permanent environment variable, add the following command to the .bashrc or .bash_profile file in the $HOME directory, and run the source .bashrc or source .bash_profile command for the variable to take effect. For a temporary environment variable, run the following command directly and change [PATH] to the actual path of the credential file.
+      ``` bash
+      export AGC_CONFIG="[PATH]/agc-apiclient-xxx-xxx.json"
+      ```
+    - On Windows, perform as follows:
+
+      To set permanent environment variables, go to Advanced system settings > Environment Variables on Windows. You are advised to restart the Windows system, or load the environment variables in another way for them to take effect.
+
+      For a temporary environment variable, run the following command directly and change [PATH] to the actual path of the credential file.
+
+      ``` bash
+      set AGC_CONFIG=[PATH]\agc-apiclient-xxx-xxx.json
+      ```
+      In this method you do not need anything more. Now on you can use services with directly like in example:
+
+      ```typescript
+      cloud.auth().sign(...)
+      ```
+- Method 2 : Specify the authentication credential path as follows. Replace [PATH] with the actual credential path:
+
+  If you do not specify environment variable you must follow this method. You can also create multiple instances with credential files
+    ```typescript
+    const cloudInstance=cloud.createInstance('./api-client-project.json',"instancename",Region.REGION_CN);
+    ```
+  [REGION] indicates the data processing location of the client. The value can be CN (China), RU (Russia), SG (Singapore), or DE (Germany).
+
+
+### Auth Service
+- Getting Auth Service
+
+  You can reach auth service with following ways:
+    ```typescript
+    const cloudInstance.auth()
+    ```
+   ```typescript
+    const cloud.auth()
+    ```
+    - Using methods
+
+      You must call functions with wrappers.
+      As you can see in example of sign method usage below
+
+         ```typescript
+        var token = cloudInstance.auth().sign({uid:"uid",displayName:"",photoUrl:"",privateKey:""})
+         ```
+### Cloud Functions
+- Getting Function Service
+
+  You can reach function service with following ways:
+    ```typescript
+    const cloudInstance.function()
+    ```
+   ```typescript
+    const cloud.function()
+    ```
+#### Calling a Function
+
+
+```
+export interface FunctionParams {
+    name: string;
+    version?: string;
+    timeout?: number;
+    data?: any;
+}
+const functionResult = cloud.function().call({name: "your-cloud-function", data: {"simple":"example"}});
+```
+
+### Note
+The default value of the version is the "-$latest" version.
+The default value of the timeout is the 55000.
+
+
+### Cloud DB
+
+#### Prerequisites
+
+Before you start using the Cloud DB Server SDK you need to create and export you Database Object Types from AGC Console. [For more information, please check the official documentation.](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-clouddb-sdk-integration-nodejs-0000001518387192#section105953115325)
+
+#### Initializing Cloud DB
+
+
+- Creates an instance and collection for the cloud database.
+- It need to be created the credential for server sdk (api-client-project.json).
+
+> During local app development, you can directly add the JS file exported from AppGallery Connect to the local development environment. Then you do not need to create object types for local app development.
+
+
+Put the obtained authentication credential in your custom directory. Call initialize to initialize the cloud-server instance corresponding to the data processing location.
+```
+const instance = cloud.createInstance('./api-client-project.json', 'createinstance', Region.REGION_CN);
+```
+Write the zone name that it created from AGC Console. It need to give class type of database object (It can export created object types from AGC Console). BookInfo is database object type that get AGC Console with exporting.
+```
+const collection = instance.database({ zoneName: 'testZone' }).collection(BookInfo);
+```
+
+#### Writing Data
+
+The insertion of a single record into the database.
+
+```
+const tempRecord = {
+    id: 1,
+    bookName: 'highway',
+    author: 'unknown',
+    publisher: 'huawei',
+    publishTime: new Date('1997-07-26T03:24:00'),
+    price: 44,
+};
+const result = await collection.insert(tempRecord);
+```
+
+The "upsert" operation (update if exists, insert if not) for a record.
+
+```
+const tempRecord = {
+    id: 1,
+    bookName: 'highway',
+    author: 'unknown',
+    publisher: 'huawei',
+    publishTime: new Date('1997-07-26T03:24:00'),
+    price: 44,
+};
+const result = await collection.upsert(tempRecord);
+```
+
+
+
+#### Querying Data
+
+The `query()` function must be called to query the database object type. After the filtering functions are run, the `get()` function must be called to get the result.
+
+```
+const query = collection.query();
+```
+
+The retrieval of records from the database.
+
+```
+const result = await query.get();
+```
+
+Querying records with a limit set to zero.
+
+```
+const result = await query.limit(0).get();
+```
+
+Querying records with a condition of price greater than or equal to 45.
+
+```
+const result = await query.greaterThanOrEqualTo('price', 45).get();
+```
+
+
+For more information about the Cloud DB Service, please check out the [Documentation Guide from the Huawei Developers Website.](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-clouddb-introduction-0000001054212760)
+
+## Cloud Storage
+
+### Constraints and Limitations
+
+Paid services usually offer a certain amount of free quota. Once the free quota is about to be used up in a billing cycle, you can either [subscribe to the pay-as-you-go plan](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-service-billing-0000001058092595#section76943113539) to avoid service interruption, or wait until the next billing cycle. Before the next billing cycle arrives, the service will be unavailable.
+
+See more detailed information on [Service Pricing and Subscription](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-service-billing-0000001058092595#section76943113539)
+
+#### Creating Instance
+
+- You can create an instance with the following way.
+```
+const storageInstance = await cloud.storage({bucketName: "your-storage-bucket"});
+```
+
+#### Bucket Upload
+
+- Upload local files to a storage instance.
+
+```
+const result: UploadResponse = await storageInstance.upload({localPath: "localPath"});
+```
+
+#### File Download
+
+- Downloading a file from the cloud to a local device.
+
+```
+const result: DownloadResponse | void = await storageInstance.download({
+                localPath: "path/to/download_file",
+                cloudPath: "path/to/cloudFile"
+            });
+```
+
+## License
+
+AGC Cloud-Server NodeJS SDK is licensed under the: "ISC" 

package/auth-service/agconnect-auth.json

@@ -0,0 +1,7 @@
+{
+  "sdk_name": "cloud-server/auth-service",
+  "sdk_version": "1.0.0",
+  "jwt_expires_time": 48,
+  "import_user_limit_size": 1000,
+  "publickey_url": "https://developer.huawei.com/consumer/cn/service/josp/agc/auth/keys"
+}

package/auth-service/auth.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+import { SignParams, FileParams, TokenParams, UidParams } from "./params";
+import { AGCAuthJwtToken, AuthAccessToken, RSAKeyPair, UserImportExportResult } from "./";
+export declare class Auth {
+    private readonly instance;
+    constructor(name: string);
+    /**
+     * @param {SignParams} params
+     * @return AGCAuthJwtToken include jwt and expire time
+     */
+    sign(params: SignParams): AGCAuthJwtToken;
+    /**
+     *  generate rsa pair key
+     * @return rsa pair key
+     */
+    generateKey(): RSAKeyPair;
+    /**
+     * import user from firebase or agc
+     * @param {FileParams}params import file path
+     * @return import result
+     */
+    importUserData(params: FileParams): Promise<UserImportExportResult>;
+    /**
+     * export users of agc project
+     * @param {FileParams}params export user data to server path
+     * @return export result
+     */
+    exportUserData(params: FileParams): Promise<UserImportExportResult>;
+    /**
+     * revoke all refresh tokens for uid
+     * @param {UidParams}uid The user id for which tokens are revoked
+     */
+    revokeRefreshTokens(uid: UidParams): Promise<void>;
+    /**
+     * verifies auth access token
+     * <p>This method to verify that the token is valid,ensure that the token is correctly signed,
+     * has not expired
+     *
+     * <p> If {@code checkRevoked} is set to true, this method will check the access token
+     * has been revoke
+     *
+     * @param {TokenParams}params auth access token
+     * @return user login info
+     */
+    verifyAccessToken(params: TokenParams): Promise<AuthAccessToken>;
+}

package/auth-service/auth.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Auth=void 0;var agc_auth_1=require("./service/agc-auth"),Auth=function(){function e(e){this.instance=agc_auth_1.AGCAuth.getInstance(e)}return e.prototype.sign=function(e){return this.instance.sign(e.uid,e.displayName,e.photoUrl,e.privateKey)},e.prototype.generateKey=function(){return this.instance.generateKey()},e.prototype.importUserData=function(e){return this.instance.importUserData(e.filePath)},e.prototype.exportUserData=function(e){return this.instance.exportUserData(e.filePath)},e.prototype.revokeRefreshTokens=function(e){return this.instance.revokeRefreshTokens(e.uid)},e.prototype.verifyAccessToken=function(e){return this.instance.verifyAccessToken(e.accessToken,e.checkRevoked)},e}();exports.Auth=Auth;

package/auth-service/backend/auth-backend.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+import { BaseResponse, RequestConstructor } from "../../common-server";
+export declare class AuthBackend {
+    private static httpClient;
+    static post(request: RequestConstructor, response: BaseResponse, enableBackurl?: boolean): Promise<void>;
+    static get(request: RequestConstructor, response: BaseResponse, enableBackurl?: boolean, ignoreRet?: boolean): Promise<void>;
+    private static initHttpClient;
+    private static getAuthCommonHeader;
+}

package/auth-service/backend/auth-backend.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,c){function a(e){try{s(r.next(e))}catch(e){c(e)}}function i(e){try{s(r.throw(e))}catch(e){c(e)}}function s(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,i)}s((r=r.apply(e,t||[])).next())}))},__generator=this&&this.__generator||function(e,t){var n,r,o,c,a={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return c={next:i(0),throw:i(1),return:i(2)},"function"==typeof Symbol&&(c[Symbol.iterator]=function(){return this}),c;function i(i){return function(s){return function(i){if(n)throw new TypeError("Generator is already executing.");for(;c&&(c=0,i[0]&&(a=0)),a;)try{if(n=1,r&&(o=2&i[0]?r.return:i[0]?r.throw||((o=r.return)&&o.call(r),0):r.next)&&!(o=o.call(r,i[1])).done)return o;switch(r=0,o&&(i=[2&i[0],o.value]),i[0]){case 0:case 1:o=i;break;case 4:return a.label++,{value:i[1],done:!1};case 5:a.label++,r=i[1],i=[0];continue;case 7:i=a.ops.pop(),a.trys.pop();continue;default:if(!(o=a.trys,(o=o.length>0&&o[o.length-1])||6!==i[0]&&2!==i[0])){a=0;continue}if(3===i[0]&&(!o||i[1]>o[0]&&i[1]<o[3])){a.label=i[1];break}if(6===i[0]&&a.label<o[1]){a.label=o[1],o=i;break}if(o&&a.label<o[2]){a.label=o[2],a.ops.push(i);break}o[2]&&a.ops.pop(),a.trys.pop();continue}i=t.call(e,a)}catch(e){i=[6,e],r=0}finally{n=o=0}if(5&i[0])throw i[1];return{value:i[0]?i[1]:void 0,done:!0}}([i,s])}}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.AuthBackend=void 0;var common_server_1=require("../../common-server"),AuthBackend=function(){function e(){}return e.post=function(t,n,r){return __awaiter(this,void 0,void 0,(function(){var o,c=this;return __generator(this,(function(a){switch(a.label){case 0:return e.initHttpClient(),[4,t.getHeader()];case 1:return o=a.sent(),[4,e.httpClient.post(t.getUrl(),t.getBody(),null,o).then((function(e){0===e.data.ret.code&&n.constructResponse(e),n.setRet(new common_server_1.ConnectRet(e.data.ret.code,e.data.ret.msg))})).catch((function(a){return __awaiter(c,void 0,void 0,(function(){return __generator(this,(function(c){switch(c.label){case 0:return common_server_1.CloudGwUrlUtil.checkUseBackUrl(a,r)?[4,e.httpClient.post(t.getUrl(!0),t.getBody(),null,o).then((function(e){0===e.data.ret.code&&n.constructResponse(e),n.setRet(new common_server_1.ConnectRet(e.data.ret.code,e.data.ret.msg))})).catch((function(e){return Promise.reject(e)}))]:[3,2];case 1:return c.sent(),[3,3];case 2:return[2,Promise.reject(a)];case 3:return[2]}}))}))}))];case 2:return a.sent(),[2]}}))}))},e.get=function(t,n,r,o){return __awaiter(this,void 0,void 0,(function(){var c,a=this;return __generator(this,(function(i){switch(i.label){case 0:return e.initHttpClient(),[4,t.getHeader()];case 1:return c=i.sent(),[4,e.httpClient.get(t.getUrl(),t.getBody(),c).then((function(e){o?n.constructResponse(e):(0===e.data.ret.code&&n.constructResponse(e),n.setRet(new common_server_1.ConnectRet(e.data.ret.code,e.data.ret.msg)))})).catch((function(i){return __awaiter(a,void 0,void 0,(function(){return __generator(this,(function(a){switch(a.label){case 0:return common_server_1.CloudGwUrlUtil.checkUseBackUrl(i,r)?[4,e.httpClient.get(t.getUrl(!0),t.getBody(),c).then((function(e){o?n.constructResponse(e):(0===e.data.ret.code&&n.constructResponse(e),n.setRet(new common_server_1.ConnectRet(e.data.ret.code,e.data.ret.msg)))})).catch((function(e){return Promise.reject(e)}))]:[3,2];case 1:return a.sent(),[3,3];case 2:return[2,Promise.reject(i)];case 3:return[2]}}))}))}))];case 2:return i.sent(),[2]}}))}))},e.initHttpClient=function(){if(!e.httpClient){var t={commonHeaders:e.getAuthCommonHeader()};e.httpClient=(0,common_server_1.getHttpClient)(t)}},e.getAuthCommonHeader=function(){return{serverSdkName:common_server_1.CommonHeaders.SDK_PREFIX+common_server_1.ConfigService.getService("AUTH").getConfigValue(common_server_1.CommonHeaders.SDK_NAME),serverSdkVersion:common_server_1.ConfigService.getService("AUTH").getConfigValue(common_server_1.CommonHeaders.SDK_VERSION)}},e.httpClient=void 0,e}();exports.AuthBackend=AuthBackend;

package/auth-service/entity/auth-access-token-impl.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+import { TokenProviderInfo } from "./token-provider-info";
+import { AuthAccessToken } from "./auth-access-token";
+export declare class AuthAccessTokenImpl implements AuthAccessToken {
+    /**
+     * the user's display name
+     */
+    private name;
+    /**
+     * the user's avatar address
+     */
+    private picture;
+    /**
+     * Issuer of JWT
+     */
+    private iss;
+    /**
+     * projectId
+     */
+    private aud;
+    /**
+     * last login time
+     */
+    private authTime;
+    /**
+     * userId
+     */
+    private sub;
+    /**
+     * create time of jwt
+     */
+    private iat;
+    /**
+     * expire time of jwt
+     */
+    private exp;
+    private email;
+    private phone;
+    /**
+     * email address has been verified
+     */
+    private emailVerified;
+    /**
+     * user info
+     */
+    private providerInfo;
+    constructor(obj?: any);
+    getName(): string | undefined;
+    getPicture(): string | undefined;
+    getIss(): string | undefined;
+    setIss(iss: string): void;
+    getAud(): string | undefined;
+    setAud(aud: string): void;
+    getAuthTime(): number | undefined;
+    getSub(): string | undefined;
+    setSub(sub: string): void;
+    getIat(): number | undefined;
+    setIat(iat: number): void;
+    getExp(): number | undefined;
+    setExp(exp: number): void;
+    getEmail(): string | undefined;
+    getPhone(): string | undefined;
+    isEmailVerified(): boolean | undefined;
+    getProviderInfo(): TokenProviderInfo | undefined;
+}

package/auth-service/entity/auth-access-token-impl.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.AuthAccessTokenImpl=void 0;var token_provider_info_1=require("./token-provider-info"),provider_1=require("./provider"),AuthAccessTokenImpl=function(){function t(t){if(t&&(this.name=t.name,this.picture=t.picture,this.iss=t.iss,this.aud=t.aud,this.authTime=t.auth_time,this.sub=t.sub,this.iat=t.iat,this.exp=t.exp,this.email=t.email,this.phone=t.phone,this.emailVerified=t.email_verified,t.agc&&(this.providerInfo=new token_provider_info_1.TokenProviderInfo,this.providerInfo.setSignInProvider(t.agc.sign_in_provider),t.agc.providers&&Array.isArray(t.agc.providers)))){for(var e=[],i=0;i<t.agc.providers.length;i++){var r=new provider_1.Provider;r.setProvider(t.agc.providers[i].provider),r.setProviderUid(t.agc.providers[i].provider_uid),e.push(r)}this.providerInfo.setProviders(e)}}return t.prototype.getName=function(){return this.name},t.prototype.getPicture=function(){return this.picture},t.prototype.getIss=function(){return this.iss},t.prototype.setIss=function(t){this.iss=t},t.prototype.getAud=function(){return this.aud},t.prototype.setAud=function(t){this.aud=t},t.prototype.getAuthTime=function(){return this.authTime},t.prototype.getSub=function(){return this.sub},t.prototype.setSub=function(t){this.sub=t},t.prototype.getIat=function(){return this.iat},t.prototype.setIat=function(t){this.iat=t},t.prototype.getExp=function(){return this.exp},t.prototype.setExp=function(t){this.exp=t},t.prototype.getEmail=function(){return this.email},t.prototype.getPhone=function(){return this.phone},t.prototype.isEmailVerified=function(){return this.emailVerified},t.prototype.getProviderInfo=function(){return this.providerInfo},t}();exports.AuthAccessTokenImpl=AuthAccessTokenImpl;

package/auth-service/entity/auth-access-token.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+import { TokenProviderInfo } from "./token-provider-info";
+export interface AuthAccessToken {
+    /**
+     * the user's display name
+     */
+    getName(): string | undefined;
+    /**
+     * the user's avatar address
+     */
+    getPicture(): string | undefined;
+    /**
+     * Issuer of JWT
+     */
+    getIss(): string | undefined;
+    /**
+     * projectId
+     */
+    getAud(): string | undefined;
+    /**
+     * last login time
+     */
+    getAuthTime(): number | undefined;
+    /**
+     * userId
+     */
+    getSub(): string | undefined;
+    /**
+     * create time of jwt
+     */
+    getIat(): number | undefined;
+    /**
+     * expire time of jwt
+     */
+    getExp(): number | undefined;
+    /**
+     * email
+     */
+    getEmail(): string | undefined;
+    /**
+     * phone
+     */
+    getPhone(): string | undefined;
+    /**
+     * email address has been verified
+     */
+    isEmailVerified(): boolean | undefined;
+    /**
+     * user info
+     */
+    getProviderInfo(): TokenProviderInfo | undefined;
+}

package/auth-service/entity/auth-access-token.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/auth-service/entity/provider.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+export declare class Provider {
+    /**
+     * provider id
+     */
+    private provider;
+    /**
+     * provider user id
+     */
+    private providerUid;
+    getProvider(): number | undefined;
+    setProvider(provider: number): void;
+    getProviderUid(): string | undefined;
+    setProviderUid(providerUid: string): void;
+}

package/auth-service/entity/provider.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Provider=void 0;var Provider=function(){function r(){this.provider=void 0,this.providerUid=void 0}return r.prototype.getProvider=function(){return this.provider},r.prototype.setProvider=function(r){this.provider=r},r.prototype.getProviderUid=function(){return this.providerUid},r.prototype.setProviderUid=function(r){this.providerUid=r},r}();exports.Provider=Provider;

package/auth-service/entity/token-provider-info.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+import { Provider } from "./provider";
+export declare class TokenProviderInfo {
+    /**
+     * authentication mode used for login
+     */
+    private signInProvider;
+    /**
+     * different authentication mode user info
+     */
+    private providers;
+    getSignInProvider(): number | undefined;
+    setSignInProvider(signInProvider: number): void;
+    getProviders(): Provider[] | undefined;
+    setProviders(providers: Provider[]): void;
+}

package/auth-service/entity/token-provider-info.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TokenProviderInfo=void 0;var TokenProviderInfo=function(){function r(){}return r.prototype.getSignInProvider=function(){return this.signInProvider},r.prototype.setSignInProvider=function(r){this.signInProvider=r},r.prototype.getProviders=function(){return this.providers},r.prototype.setProviders=function(r){this.providers=r},r}();exports.TokenProviderInfo=TokenProviderInfo;

package/auth-service/entity/user-import-export-result.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+export declare class UserImportExportResult {
+    /**
+     * success user count
+     */
+    private successUsers;
+    /**
+     * error user count
+     */
+    private errorUsers;
+    /**
+     * error user list
+     */
+    private errorUsersList;
+    constructor(successList: string[], failList: string[]);
+    /**
+     * success user count
+     * @return count
+     */
+    getSuccessCount(): number | undefined;
+    /**
+     * error user count
+     * @return count
+     */
+    getErrorUsers(): number | undefined;
+    /**
+     * error user list
+     * @return list
+     */
+    getErrorUsersList(): string[] | undefined;
+}

package/auth-service/entity/user-import-export-result.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.UserImportExportResult=void 0;var UserImportExportResult=function(){function r(r,s){this.successUsers=void 0,this.errorUsers=void 0,this.errorUsersList=void 0,this.successUsers=r.length,this.errorUsers=s.length,this.errorUsersList=s}return r.prototype.getSuccessCount=function(){return this.successUsers},r.prototype.getErrorUsers=function(){return this.errorUsers},r.prototype.getErrorUsersList=function(){return this.errorUsersList},r}();exports.UserImportExportResult=UserImportExportResult;

package/auth-service/error/agc-auth-error-message.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+import { ErrorCode } from "../../common-server";
+/**
+ * Exception Definition Class.11000-11999
+ */
+export declare class AuthErrorCode {
+    static readonly CLIENT_INITIALIZE_FAILED: ErrorCode;
+    static readonly PROJECT_DO_NOT_SET_REGION: ErrorCode;
+    static readonly UID_IS_INVALID: ErrorCode;
+    static readonly SIGN_PRIVATE_KEY_IS_INVALID: ErrorCode;
+    static readonly PHOTOURL_INVALID: ErrorCode;
+    static readonly FAILED_TO_SIGN_JWT_TOKEN: ErrorCode;
+    static readonly FAILED_TO_GENERATE_RSA_KEY_PAIR: ErrorCode;
+    static readonly INVALID_IMPORT_USER_DATA: ErrorCode;
+    static readonly IMPORT_USER_DATA_OVER_LIMIT_SIZE: ErrorCode;
+    static readonly INVALID_IMPORT_USER_FILE: ErrorCode;
+    static readonly INVALID_ACCESS_IMPORT_USER_FILE: ErrorCode;
+    static readonly IMPORT_USER_FAILED: ErrorCode;
+    static readonly EXPORT_USER_DATA_FILEPATH_IS_INVALID: ErrorCode;
+    static readonly GET_BLOCK_USER_LIST_FAILED: ErrorCode;
+    static readonly GET_EXPORT_USER_FAILED: ErrorCode;
+    static readonly INVALID_ACCESS_EXPORT_USER_FILE: ErrorCode;
+    static readonly EXPORT_USER_TO_FILE_FAILED: ErrorCode;
+    static readonly REVOKE_REFRESH_TOKENS_UID_IS_NULL: ErrorCode;
+    static readonly REVOKE_REFRESH_TOKENS_FAILED: ErrorCode;
+    static readonly VERIFY_ACCESS_TOKEN_ACCESS_TOKEN_IS_NULL: ErrorCode;
+    static readonly ACCESS_TOKEN_INVALID_FORMAT: ErrorCode;
+    static readonly ACCESS_TOKEN_VERIFY_FAILED: ErrorCode;
+    static readonly JWT_EXPIRE: ErrorCode;
+    static readonly GET_PUBLIC_KEY_FAILED: ErrorCode;
+    static readonly ACCESS_TOKEN_ALG_IS_INVALID: ErrorCode;
+    static readonly ACCESS_TOKEN_KID_IS_INVALID: ErrorCode;
+    static readonly JWT_VERIFY_FAILED: ErrorCode;
+    static readonly JWT_REVOKED: ErrorCode;
+    static readonly EXPORT_USER_FILE_DIR_NOT_EXIST: ErrorCode;
+    static readonly INVOKE_INTERFACE_FAIL: ErrorCode;
+}

package/auth-service/error/agc-auth-error-message.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.AuthErrorCode=void 0;var AuthErrorCode=function(){function e(){}return e.CLIENT_INITIALIZE_FAILED={code:"11000",message:"failed to initialize the client"},e.PROJECT_DO_NOT_SET_REGION={code:"11001",message:"no data storage location is set for the project"},e.UID_IS_INVALID={code:"11002",message:"uid is invalid."},e.SIGN_PRIVATE_KEY_IS_INVALID={code:"11003",message:"the private key for user signature is invalid"},e.PHOTOURL_INVALID={code:"11004",message:"photo url invalid"},e.FAILED_TO_SIGN_JWT_TOKEN={code:"11005",message:"jwt signature failed."},e.FAILED_TO_GENERATE_RSA_KEY_PAIR={code:"11006",message:"failed to generate the rsa public and private keys"},e.INVALID_IMPORT_USER_DATA={code:"11007",message:"the imported user file data is invalid"},e.IMPORT_USER_DATA_OVER_LIMIT_SIZE={code:"11008",message:"the number of imported users exceeds the upper limit"},e.INVALID_IMPORT_USER_FILE={code:"11009",message:"the imported user file is invalid"},e.INVALID_ACCESS_IMPORT_USER_FILE={code:"11010",message:"no permission to read the imported user file"},e.IMPORT_USER_FAILED={code:"11011",message:"import user failed"},e.EXPORT_USER_DATA_FILEPATH_IS_INVALID={code:"11012",message:"the exported user file path is invalid"},e.GET_BLOCK_USER_LIST_FAILED={code:"11013",message:"get block user list failed"},e.GET_EXPORT_USER_FAILED={code:"11014",message:"get export user failed"},e.INVALID_ACCESS_EXPORT_USER_FILE={code:"11015",message:"no permission to write the file for exporting user"},e.EXPORT_USER_TO_FILE_FAILED={code:"11016",message:"export user to file failed"},e.REVOKE_REFRESH_TOKENS_UID_IS_NULL={code:"11017",message:"uid for revoke tokens is null"},e.REVOKE_REFRESH_TOKENS_FAILED={code:"11018",message:"revoke tokens failed"},e.VERIFY_ACCESS_TOKEN_ACCESS_TOKEN_IS_NULL={code:"11019",message:"accesstoken for verify access tokens is null"},e.ACCESS_TOKEN_INVALID_FORMAT={code:"11020",message:"access token invalid format"},e.ACCESS_TOKEN_VERIFY_FAILED={code:"11021",message:"access token varify failed"},e.JWT_EXPIRE={code:"11022",message:"jwt expire"},e.GET_PUBLIC_KEY_FAILED={code:"11023",message:"get public key failed"},e.ACCESS_TOKEN_ALG_IS_INVALID={code:"11024",message:"access token algorithm is invalid"},e.ACCESS_TOKEN_KID_IS_INVALID={code:"11025",message:"access token kid is invalid"},e.JWT_VERIFY_FAILED={code:"11026",message:"jwt verify failed"},e.JWT_REVOKED={code:"11027",message:"jwt revoked"},e.EXPORT_USER_FILE_DIR_NOT_EXIST={code:"11028",message:"folder of export user file does not exist"},e.INVOKE_INTERFACE_FAIL={code:"11029",message:"invoke interface failed"},e}();exports.AuthErrorCode=AuthErrorCode;

package/auth-service/error/agc-auth-error.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+import { AGCError, ErrorCode } from "../../common-server";
+export declare class AGCAuthError extends AGCError {
+    constructor(errorCode: ErrorCode, name: string, extra?: any);
+}

package/auth-service/error/agc-auth-error.js

@@ -0,0 +1 @@
+"use strict";var __extends=this&&this.__extends||function(){var r=function(t,e){return r=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(r,t){r.__proto__=t}||function(r,t){for(var e in t)Object.prototype.hasOwnProperty.call(t,e)&&(r[e]=t[e])},r(t,e)};return function(t,e){if("function"!=typeof e&&null!==e)throw new TypeError("Class extends value "+String(e)+" is not a constructor or null");function o(){this.constructor=t}r(t,e),t.prototype=null===e?Object.create(e):(o.prototype=e.prototype,new o)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.AGCAuthError=void 0;var common_server_1=require("../../common-server"),agc_auth_service_impl_1=require("../service/impl/agc-auth-service-impl"),AGCAuthError=function(r){function t(e,o,n){var s=this;return(s=n&&n.message&&"string"==typeof n.message?r.call(this,e,o,agc_auth_service_impl_1.SERVICE_NAME,n.message)||this:r.call(this,e,o,agc_auth_service_impl_1.SERVICE_NAME)||this).__proto__=t.prototype,s}return __extends(t,r),t}(common_server_1.AGCError);exports.AGCAuthError=AGCAuthError;

package/auth-service/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+export { TokenProviderInfo } from "./entity/token-provider-info";
+export { Provider } from "./entity/provider";
+export { RSAKeyPair } from "./jwt/rsa-key-pair";
+export { AGCAuthJwtToken } from "./jwt/agc-auth-jwttoken";
+export { UserImportExportResult } from "./entity/user-import-export-result";
+export { AuthAccessToken } from "./entity/auth-access-token";
+export { AuthErrorCode } from "./error/agc-auth-error-message";
+export { AGCAuthError } from "./error/agc-auth-error";
+export { Auth } from "./auth";
+export * from "./params";

package/auth-service/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var n=Object.getOwnPropertyDescriptor(r,t);n&&!("get"in n?!r.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,n)}:function(e,r,t,o){void 0===o&&(o=t),e[o]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Auth=exports.AGCAuthError=exports.AuthErrorCode=exports.UserImportExportResult=exports.AGCAuthJwtToken=exports.Provider=exports.TokenProviderInfo=void 0;var token_provider_info_1=require("./entity/token-provider-info");Object.defineProperty(exports,"TokenProviderInfo",{enumerable:!0,get:function(){return token_provider_info_1.TokenProviderInfo}});var provider_1=require("./entity/provider");Object.defineProperty(exports,"Provider",{enumerable:!0,get:function(){return provider_1.Provider}});var agc_auth_jwttoken_1=require("./jwt/agc-auth-jwttoken");Object.defineProperty(exports,"AGCAuthJwtToken",{enumerable:!0,get:function(){return agc_auth_jwttoken_1.AGCAuthJwtToken}});var user_import_export_result_1=require("./entity/user-import-export-result");Object.defineProperty(exports,"UserImportExportResult",{enumerable:!0,get:function(){return user_import_export_result_1.UserImportExportResult}});var agc_auth_error_message_1=require("./error/agc-auth-error-message");Object.defineProperty(exports,"AuthErrorCode",{enumerable:!0,get:function(){return agc_auth_error_message_1.AuthErrorCode}});var agc_auth_error_1=require("./error/agc-auth-error");Object.defineProperty(exports,"AGCAuthError",{enumerable:!0,get:function(){return agc_auth_error_1.AGCAuthError}});var auth_1=require("./auth");Object.defineProperty(exports,"Auth",{enumerable:!0,get:function(){return auth_1.Auth}}),__exportStar(require("./params"),exports);

package/auth-service/jwt/agc-auth-jwt.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Huawei Technologies Co., Ltd. 2023 All rights reserved.
+ */
+export declare class AGCAuthJwt {
+    private static SEP;
+    private static HEAD;
+    private static PAYLOAD;
+    private static SIGNATURE;
+    private header;
+    private payload;
+    private signature;
+    static parse(jwtToken: string): AGCAuthJwt;
+    parseAlg(): string | null;
+    parseKid(): string | null;
+    parsePayload(): string;
+    expire(): boolean;
+}

package/auth-service/jwt/agc-auth-jwt.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.AGCAuthJwt=void 0;var AGCAuthJwt=function(){function e(){}return e.parse=function(r){var t=r.split(e.SEP),a=new e;return a.header=t[e.HEAD],a.payload=t[e.PAYLOAD],a.signature=t[e.SIGNATURE],a},e.prototype.parseAlg=function(){var e=JSON.parse(Buffer.from(this.header,"base64").toString());return e.alg?e.alg:null},e.prototype.parseKid=function(){var e=JSON.parse(Buffer.from(this.header,"base64").toString());return e.kid?e.kid:null},e.prototype.parsePayload=function(){return JSON.parse(Buffer.from(this.payload,"base64").toString())},e.prototype.expire=function(){var e=JSON.parse(Buffer.from(this.payload,"base64").toString());return e.exp>0&&Math.round((new Date).getTime()/1e3)>e.exp},e.SEP=".",e.HEAD=0,e.PAYLOAD=1,e.SIGNATURE=2,e}();exports.AGCAuthJwt=AGCAuthJwt;