@sendbird/sendbird-platform-sdk-typescript 2.1.2 → 2.1.6

package/apis/baseapi.ts

@@ -1,37 +0,0 @@
-import { Configuration } from '../configuration'
-
-/**
- *
- * @export
- */
-export const COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-
-
-/**
- *
- * @export
- * @class BaseAPI
- */
-export class BaseAPIRequestFactory {
-
-    constructor(protected configuration: Configuration) {
-    }
-};
-
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export class RequiredError extends Error {
-    name: "RequiredError" = "RequiredError";
-    constructor(public api: string, public method: string, public field: string) {
-        super("Required parameter " + field + " was null or undefined when calling " + api + "." + method + ".");
-    }
-}

package/apis/exception.ts

@@ -1,15 +0,0 @@
-/**
- * Represents an error caused by an api call i.e. it has attributes for a HTTP status code
- * and the returned body object.
- *
- * Example
- * API returns a ErrorMessageObject whenever HTTP status code is not in [200, 299]
- * => ApiException(404, someErrorMessageObject)
- *
- */
-export class ApiException<T> extends Error {
-    public constructor(public code: number, message: string, public body: T, public headers: { [key: string]: string; }) {
-        super("HTTP-Code: " + code + "\nMessage: " + message + "\nBody: " + JSON.stringify(body) + "\nHeaders: " +
-        JSON.stringify(headers))
-    }
-}

package/auth/auth.ts

@@ -1,54 +0,0 @@
-// typings for btoa are incorrect
-//@ts-ignore
-import * as btoa from "btoa";
-import { RequestContext } from "../http/http";
-
-/**
- * Interface authentication schemes.
- */
-export interface SecurityAuthentication {
-    /*
-     * @return returns the name of the security authentication as specified in OAI
-     */
-    getName(): string;
-
-    /**
-     * Applies the authentication scheme to the request context
-     *
-     * @params context the request context which should use this authentication scheme
-     */
-    applySecurityAuthentication(context: RequestContext): void | Promise<void>;
-}
-
-export interface TokenProvider {
-  getToken(): Promise<string> | string;
-}
-
-
-export type AuthMethods = {
-    "default"?: SecurityAuthentication,
-}
-
-export type ApiKeyConfiguration = string;
-export type HttpBasicConfiguration = { "username": string, "password": string };
-export type HttpBearerConfiguration = { tokenProvider: TokenProvider };
-export type OAuth2Configuration = { accessToken: string };
-
-export type AuthMethodsConfiguration = {
-    "default"?: SecurityAuthentication,
-}
-
-/**
- * Creates the authentication methods from a swagger description.
- *
- */
-export function configureAuthMethods(config: AuthMethodsConfiguration | undefined): AuthMethods {
-    let authMethods: AuthMethods = {}
-
-    if (!config) {
-        return authMethods;
-    }
-    authMethods["default"] = config["default"]
-
-    return authMethods;
-}

package/catalog-info.yaml

@@ -1,12 +0,0 @@
-apiVersion: backstage.io/v1alpha1
-kind: Component
-metadata:
-  name: sendbird-platform-sdk-typescript
-description: sendbird-platform-sdk-typescript
-  annotations:
-    github.com/project-slug: sendbird/sendbird-platform-sdk-typescript
-spec:
-  type: library
-  lifecycle: production
-  owner: dep-developer-experience
-  system: sendbird-uikit

package/configuration.ts

@@ -1,66 +0,0 @@
-import { HttpLibrary } from "./http/http";
-import { Middleware, PromiseMiddleware, PromiseMiddlewareWrapper } from "./middleware";
-import { IsomorphicFetchHttpLibrary as DefaultHttpLibrary } from "./http/isomorphic-fetch";
-import { BaseServerConfiguration, server1 } from "./servers";
-import { configureAuthMethods, AuthMethods, AuthMethodsConfiguration } from "./auth/auth";
-
-export interface Configuration {
-    readonly baseServer: BaseServerConfiguration;
-    readonly httpApi: HttpLibrary;
-    readonly middleware: Middleware[];
-    readonly authMethods: AuthMethods;
-}
-
-
-/**
- * Interface with which a configuration object can be configured.
- */
-export interface ConfigurationParameters {
-    /**
-     * Default server to use
-     */
-    baseServer?: BaseServerConfiguration;
-    /**
-     * HTTP library to use e.g. IsomorphicFetch
-     */
-    httpApi?: HttpLibrary;
-    /**
-     * The middlewares which will be applied to requests and responses
-     */
-    middleware?: Middleware[];
-    /**
-     * Configures all middlewares using the promise api instead of observables (which Middleware uses)
-     */
-    promiseMiddleware?: PromiseMiddleware[];
-    /**
-     * Configuration for the available authentication methods
-     */
-    authMethods?: AuthMethodsConfiguration
-}
-
-/**
- * Configuration factory function
- *
- * If a property is not included in conf, a default is used:
- *    - baseServer: server1
- *    - httpApi: IsomorphicFetchHttpLibrary
- *    - middleware: []
- *    - promiseMiddleware: []
- *    - authMethods: {}
- *
- * @param conf partial configuration
- */
-export function createConfiguration(conf: ConfigurationParameters = {}): Configuration {
-    const configuration: Configuration = {
-        baseServer: conf.baseServer !== undefined ? conf.baseServer : server1,
-        httpApi: conf.httpApi || new DefaultHttpLibrary(),
-        middleware: conf.middleware || [],
-        authMethods: configureAuthMethods(conf.authMethods)
-    };
-    if (conf.promiseMiddleware) {
-        conf.promiseMiddleware.forEach(
-            m => configuration.middleware.push(new PromiseMiddlewareWrapper(m))
-        );
-    }
-    return configuration;
-}

package/git_push.sh

@@ -1,51 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="sendbird"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="sendbird-platform-sdk-typescript"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@github.com/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/http/http.ts

@@ -1,231 +0,0 @@
-// TODO: evaluate if we can easily get rid of this library
-import * as FormData from "form-data";
-import { URLSearchParams } from 'url';
-import * as http from 'http';
-import * as https from 'https';
-import * as URLParse from "url-parse";
-import { Observable, from } from '../rxjsStub';
-
-export * from './isomorphic-fetch';
-
-/**
- * Represents an HTTP method.
- */
-export enum HttpMethod {
-    GET = "GET",
-    HEAD = "HEAD",
-    POST = "POST",
-    PUT = "PUT",
-    DELETE = "DELETE",
-    CONNECT = "CONNECT",
-    OPTIONS = "OPTIONS",
-    TRACE = "TRACE",
-    PATCH = "PATCH"
-}
-
-/**
- * Represents an HTTP file which will be transferred from or to a server.
- */
-export type HttpFile = {
-    data: Buffer,
-    name: string
-};
-
-
-export class HttpException extends Error {
-    public constructor(msg: string) {
-        super(msg);
-    }
-}
-
-/**
- * Represents the body of an outgoing HTTP request.
- */
-export type RequestBody = undefined | string | FormData | URLSearchParams;
-
-/**
- * Represents an HTTP request context
- */
-export class RequestContext {
-    private headers: { [key: string]: string } = {};
-    private body: RequestBody = undefined;
-    private url: URLParse;
-    private agent: http.Agent | https.Agent | undefined = undefined;
-
-    /**
-     * Creates the request context using a http method and request resource url
-     *
-     * @param url url of the requested resource
-     * @param httpMethod http method
-     */
-    public constructor(url: string, private httpMethod: HttpMethod) {
-        this.url = new URLParse(url, true);
-    }
-
-    /*
-     * Returns the url set in the constructor including the query string
-     *
-     */
-    public getUrl(): string {
-        return this.url.toString();
-    }
-
-    /**
-     * Replaces the url set in the constructor with this url.
-     *
-     */
-    public setUrl(url: string) {
-        this.url = new URLParse(url, true);
-    }
-
-    /**
-     * Sets the body of the http request either as a string or FormData
-     *
-     * Note that setting a body on a HTTP GET, HEAD, DELETE, CONNECT or TRACE
-     * request is discouraged.
-     * https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html#rfc.section.7.3.1
-     *
-     * @param body the body of the request
-     */
-    public setBody(body: RequestBody) {
-        this.body = body;
-    }
-
-    public getHttpMethod(): HttpMethod {
-        return this.httpMethod;
-    }
-
-    public getHeaders(): { [key: string]: string } {
-        return this.headers;
-    }
-
-    public getBody(): RequestBody {
-        return this.body;
-    }
-
-    public setQueryParam(name: string, value: string) {
-        let queryObj = this.url.query;
-        queryObj[name] = value;
-        this.url.set("query", queryObj);
-    }
-
-    /**
-     * Sets a cookie with the name and value. NO check  for duplicate cookies is performed
-     *
-     */
-    public addCookie(name: string, value: string): void {
-        if (!this.headers["Cookie"]) {
-            this.headers["Cookie"] = "";
-        }
-        this.headers["Cookie"] += name + "=" + value + "; ";
-    }
-
-    public setHeaderParam(key: string, value: string): void  {
-        this.headers[key] = value;
-    }
-    
-    public setAgent(agent: http.Agent | https.Agent) {
-        this.agent = agent;
-    }
-
-    public getAgent(): http.Agent | https.Agent | undefined {
-        return this.agent;
-    }
-}
-
-export interface ResponseBody {
-    text(): Promise<string>;
-    binary(): Promise<Buffer>;
-}
-
-/**
- * Helper class to generate a `ResponseBody` from binary data
- */
-export class SelfDecodingBody implements ResponseBody {
-    constructor(private dataSource: Promise<Buffer>) {}
-
-    binary(): Promise<Buffer> {
-        return this.dataSource;
-    }
-
-    async text(): Promise<string> {
-        const data: Buffer = await this.dataSource;
-        return data.toString();
-    }
-}
-
-export class ResponseContext {
-    public constructor(
-        public httpStatusCode: number,
-        public headers: { [key: string]: string },
-        public body: ResponseBody
-    ) {}
-
-    /**
-     * Parse header value in the form `value; param1="value1"`
-     *
-     * E.g. for Content-Type or Content-Disposition
-     * Parameter names are converted to lower case
-     * The first parameter is returned with the key `""`
-     */
-    public getParsedHeader(headerName: string): { [parameter: string]: string } {
-        const result: { [parameter: string]: string } = {};
-        if (!this.headers[headerName]) {
-            return result;
-        }
-
-        const parameters = this.headers[headerName].split(";");
-        for (const parameter of parameters) {
-            let [key, value] = parameter.split("=", 2);
-            key = key.toLowerCase().trim();
-            if (value === undefined) {
-                result[""] = key;
-            } else {
-                value = value.trim();
-                if (value.startsWith('"') && value.endsWith('"')) {
-                    value = value.substring(1, value.length - 1);
-                }
-                result[key] = value;
-            }
-        }
-        return result;
-    }
-
-    public async getBodyAsFile(): Promise<HttpFile> {
-        const data = await this.body.binary();
-        const fileName = this.getParsedHeader("content-disposition")["filename"] || "";
-        return { data, name: fileName };
-    }
-
-    /**
-     * Use a heuristic to get a body of unknown data structure.
-     * Return as string if possible, otherwise as binary.
-     */
-    public getBodyAsAny(): Promise<string | Buffer | undefined> {
-        try {
-            return this.body.text();
-        } catch {}
-
-        try {
-            return this.body.binary();
-        } catch {}
-
-        return Promise.resolve(undefined);
-    }
-}
-
-export interface HttpLibrary {
-    send(request: RequestContext): Observable<ResponseContext>;
-}
-
-export interface PromiseHttpLibrary {
-    send(request: RequestContext): Promise<ResponseContext>;
-}
-
-export function wrapHttpLibrary(promiseHttpLibrary: PromiseHttpLibrary): HttpLibrary {
-  return {
-    send(request: RequestContext): Observable<ResponseContext> {
-      return from(promiseHttpLibrary.send(request));
-    }
-  }
-}

package/http/isomorphic-fetch.ts

@@ -1,32 +0,0 @@
-import {HttpLibrary, RequestContext, ResponseContext} from './http';
-import { from, Observable } from '../rxjsStub';
-import fetch from "node-fetch";
-
-export class IsomorphicFetchHttpLibrary implements HttpLibrary {
-
-    public send(request: RequestContext): Observable<ResponseContext> {
-        let method = request.getHttpMethod().toString();
-        let body = request.getBody();
-
-        const resultPromise = fetch(request.getUrl(), {
-            method: method,
-            body: body as any,
-            headers: request.getHeaders(),
-            agent: request.getAgent(),
-        }).then((resp: any) => {
-            const headers: { [name: string]: string } = {};
-            resp.headers.forEach((value: string, name: string) => {
-              headers[name] = value;
-            });
-
-            const body = {
-              text: () => resp.text(),
-              binary: () => resp.buffer()
-            };
-            return new ResponseContext(resp.status, headers, body);
-        });
-
-        return from<Promise<ResponseContext>>(resultPromise);
-
-    }
-}

package/index.ts

@@ -1,12 +0,0 @@
-export * from "./http/http";
-export * from "./auth/auth";
-export * from "./models/all";
-export { createConfiguration } from "./configuration"
-export { Configuration } from "./configuration"
-export * from "./apis/exception";
-export * from "./servers";
-export { RequiredError } from "./apis/baseapi";
-
-export { PromiseMiddleware as Middleware } from './middleware';
-export { AnnouncementApiScheduleAnAnnouncementRequest, ObjectAnnouncementApi as AnnouncementApi,  BotApiCreateABotRequest, BotApiDeleteBotByIdRequest, BotApiJoinChannelsRequest, BotApiLeaveAGroupChannelRequest, BotApiLeaveGroupChannelsRequest, BotApiListBotsRequest, BotApiSendABotMessageRequest, BotApiUpdateBotByIdRequest, BotApiViewBotByIdRequest, ObjectBotApi as BotApi,  GroupChannelApiAcceptAnInvitationRequest, GroupChannelApiCancelTheRegistrationOfOperatorsRequest, GroupChannelApiCheckIfMemberRequest, GroupChannelApiCreateAGroupChannelRequest, GroupChannelApiDeleteAGroupChannelRequest, GroupChannelApiGetAGroupChannelRequest, GroupChannelApiHideAChannelRequest, GroupChannelApiInviteAsMembersRequest, GroupChannelApiJoinAChannelRequest, GroupChannelApiLeaveAChannelRequest, GroupChannelApiListChannelsRequest, GroupChannelApiListMembersRequest, GroupChannelApiListOperatorsRequest, GroupChannelApiRegisterOperatorsToAGroupChannelRequest, GroupChannelApiResetChatHistoryRequest, GroupChannelApiStartTypingIndicatorsRequest, GroupChannelApiStopTypingIndicatorsRequest, GroupChannelApiUnhideAChannelRequest, GroupChannelApiUpdateAGroupChannelRequest, ObjectGroupChannelApi as GroupChannelApi,  MessageApiAddExtraDataToAMessageRequest, MessageApiDeleteAMessageRequest, MessageApiGetAMessageRequest, MessageApiGetTotalNumberOfMessagesInAChannelRequest, MessageApiListMessagesRequest, MessageApiMarkChannelMessagesAsReadRequest, MessageApiMigrateMessagesRequest, MessageApiRemoveExtraDataFromAMessageRequest, MessageApiSendAMessageRequest, MessageApiUpdateAMessageRequest, MessageApiUpdateExtraDataInAMessageRequest, ObjectMessageApi as MessageApi,  MetadataApiCreateAChannelMetadataRequest, MetadataApiDeleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadataRequest, MetadataApiUpdateAChannelMetadataRequest, MetadataApiViewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadataRequest, ObjectMetadataApi as MetadataApi,  ModerationApiBlockAUserRequest, ModerationApiFreezeAGroupChannelRequest, ModerationApiFreezeAnOpenChannelRequest, ModerationApiListBlockedUsersRequest, ModerationApiUnblockAUserRequest, ObjectModerationApi as ModerationApi,  OpenChannelApiCreateAnOpenChannelRequest, OpenChannelApiDeleteAnOpenChannelRequest, OpenChannelApiGetAnOpenChannelRequest, OpenChannelApiListChannelOperatorsRequest, OpenChannelApiListOpenChannelsRequest, OpenChannelApiRegisterOperatorsRequest, OpenChannelApiUnregisterOperatorsRequest, OpenChannelApiUpdateAnOpenChannelRequest, ObjectOpenChannelApi as OpenChannelApi,  StatisticsApiViewNumberOfDailyActiveUsersRequest, StatisticsApiViewNumberOfMonthlyActiveUsersRequest, ObjectStatisticsApi as StatisticsApi,  UserApiAddARegistrationOrDeviceTokenRequest, UserApiChooseAPushNotificationContentTemplateRequest, UserApiCreateAUserRequest, UserApiCreateUserMetadataRequest, UserApiCreateUserTokenRequest, UserApiDeleteAUserRequest, UserApiDeleteSpecificUserMetadataRequest, UserApiDeleteUserAllMetadataRequest, UserApiGetChannelInvitationPreferenceRequest, UserApiLeaveMyGroupChannelsRequest, UserApiListMyGroupChannelsRequest, UserApiListRegistrationOrDeviceTokensRequest, UserApiListUsersRequest, UserApiMarkAllMessagesAsReadRequest, UserApiRemoveARegistrationOrDeviceTokenRequest, UserApiRemoveARegistrationOrDeviceTokenFromAnOwnerRequest, UserApiRemoveAllRegistrationOrDeviceTokenRequest, UserApiResetPushPreferencesRequest, UserApiUpdateAUserRequest, UserApiUpdateChannelInvitationPreferenceRequest, UserApiUpdateCountPreferenceOfAChannelRequest, UserApiUpdatePushPreferencesRequest, UserApiUpdatePushPreferencesForAChannelRequest, UserApiUpdateSpecificUserMetadataRequest, UserApiUpdateUserMetadataRequest, UserApiViewAUserRequest, UserApiViewCountPreferenceOfAChannelRequest, UserApiViewNumberOfChannelsWithUnreadMessagesRequest, UserApiViewNumberOfUnreadMessagesRequest, UserApiViewPushPreferencesRequest, UserApiViewPushPreferencesForAChannelRequest, UserApiViewSpecificUserMetadataRequest, UserApiViewWhoOwnsARegistrationOrDeviceTokenRequest, ObjectUserApi as UserApi } from './types/ObjectParamAPI';
-

package/jest.config.ts

@@ -1,11 +0,0 @@
-import type { Config } from 'jest';
-
-const config: Config = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  setupFiles: ['./jest.setup.ts'],
-  testPathIgnorePatterns: ['/node_modules/', '/dist/'],
-  modulePathIgnorePatterns: ['/dist/'],
-};
-
-export default config;

package/jest.setup.ts

@@ -1,5 +0,0 @@
-// jest.setup.ts
-import * as dotenv from 'dotenv';
-
-// Load .env.integration_test if it exists, fallback to .env
-dotenv.config({ path: '.env.test' });

package/middleware.ts

@@ -1,66 +0,0 @@
-import {RequestContext, ResponseContext} from './http/http';
-import { Observable, from } from './rxjsStub';
-
-/**
- * Defines the contract for a middleware intercepting requests before
- * they are sent (but after the RequestContext was created)
- * and before the ResponseContext is unwrapped.
- *
- */
-export interface Middleware {
-    /**
-     * Modifies the request before the request is sent.
-     *
-     * @param context RequestContext of a request which is about to be sent to the server
-     * @returns an observable of the updated request context
-     *
-     */
-    pre(context: RequestContext): Observable<RequestContext>;
-    /**
-     * Modifies the returned response before it is deserialized.
-     *
-     * @param context ResponseContext of a sent request
-     * @returns an observable of the modified response context
-     */
-    post(context: ResponseContext): Observable<ResponseContext>;
-}
-
-export class PromiseMiddlewareWrapper implements Middleware {
-
-    public constructor(private middleware: PromiseMiddleware) {
-
-    }
-
-    pre(context: RequestContext): Observable<RequestContext> {
-        return from(this.middleware.pre(context));
-    }
-
-    post(context: ResponseContext): Observable<ResponseContext> {
-        return from(this.middleware.post(context));
-    }
-
-}
-
-/**
- * Defines the contract for a middleware intercepting requests before
- * they are sent (but after the RequestContext was created)
- * and before the ResponseContext is unwrapped.
- *
- */
-export interface PromiseMiddleware {
-    /**
-     * Modifies the request before the request is sent.
-     *
-     * @param context RequestContext of a request which is about to be sent to the server
-     * @returns an observable of the updated request context
-     *
-     */
-    pre(context: RequestContext): Promise<RequestContext>;
-        /**
-     * Modifies the returned response before it is deserialized.
-     *
-     * @param context ResponseContext of a sent request
-     * @returns an observable of the modified response context
-     */
-    post(context: ResponseContext): Promise<ResponseContext>;
-}

package/models/AcceptAnInvitationRequest.ts

@@ -1,42 +0,0 @@
-/**
- * Sendbird Platform SDK
- * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
- *
- * OpenAPI spec version: 1.0.0
- * Contact: support@sendbird.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import { HttpFile } from '../http/http';
-
-export class AcceptAnInvitationRequest {
-    'accessCode'?: string;
-    'userId': string;
-
-    static readonly discriminator: string | undefined = undefined;
-
-    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
-        {
-            "name": "accessCode",
-            "baseName": "access_code",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "userId",
-            "baseName": "user_id",
-            "type": "string",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return AcceptAnInvitationRequest.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-