@midwayjs/faas 3.12.3 → 3.12.5

package/dist/interface.d.ts

@@ -1,7 +1,375 @@
+/// <reference types="node" />
 import { MidwayRequestContainer, IMidwayApplication, IConfigurationOptions, IMidwayContext, NextFunction as BaseNextFunction, CommonMiddlewareUnion, ContextMiddlewareManager, IMidwayBootstrapOptions, ObjectIdentifier } from '@midwayjs/core';
-import { FaaSHTTPContext } from '@midwayjs/faas-typings';
 import { ILogger } from '@midwayjs/logger';
 import { Application as ServerlessHttpApplication, HttpResponseOptions } from '@midwayjs/serverless-http-parser';
+import { Cookies } from '@midwayjs/cookies';
+import { Writable } from 'stream';
+interface ContextDelegatedRequest {
+    /**
+     * Check if the given `type(s)` is acceptable, returning
+     * the best match when true, otherwise `undefined`, in which
+     * case you should respond with 406 "Not Acceptable".
+     *
+     * The `type` value may be a single mime type string
+     * such as "application/json", the extension name
+     * such as "json" or an array `["json", "html", "text/plain"]`. When a list
+     * or array is given the _best_ match, if any is returned.
+     *
+     * Examples:
+     *
+     *     // Accept: text/html
+     *     this.accepts('html');
+     *     // => "html"
+     *
+     *     // Accept: text/*, application/json
+     *     this.accepts('html');
+     *     // => "html"
+     *     this.accepts('text/html');
+     *     // => "text/html"
+     *     this.accepts('json', 'text');
+     *     // => "json"
+     *     this.accepts('application/json');
+     *     // => "application/json"
+     *
+     *     // Accept: text/*, application/json
+     *     this.accepts('image/png');
+     *     this.accepts('png');
+     *     // => undefined
+     *
+     *     // Accept: text/*;q=.5, application/json
+     *     this.accepts(['html', 'json']);
+     *     this.accepts('html', 'json');
+     *     // => "json"
+     */
+    accepts(): string[] | boolean;
+    accepts(...types: string[]): string | boolean;
+    accepts(types: string[]): string | boolean;
+    /**
+     * Return accepted encodings or best fit based on `encodings`.
+     *
+     * Given `Accept-Encoding: gzip, deflate`
+     * an array sorted by quality is returned:
+     *
+     *     ['gzip', 'deflate']
+     */
+    acceptsEncodings(): string[] | boolean;
+    acceptsEncodings(...encodings: string[]): string | boolean;
+    acceptsEncodings(encodings: string[]): string | boolean;
+    /**
+     * Return accepted charsets or best fit based on `charsets`.
+     *
+     * Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5`
+     * an array sorted by quality is returned:
+     *
+     *     ['utf-8', 'utf-7', 'iso-8859-1']
+     */
+    acceptsCharsets(): string[] | boolean;
+    acceptsCharsets(...charsets: string[]): string | boolean;
+    acceptsCharsets(charsets: string[]): string | boolean;
+    /**
+     * Return accepted languages or best fit based on `langs`.
+     *
+     * Given `Accept-Language: en;q=0.8, es, pt`
+     * an array sorted by quality is returned:
+     *
+     *     ['es', 'pt', 'en']
+     */
+    acceptsLanguages(): string[] | boolean;
+    acceptsLanguages(...langs: string[]): string | boolean;
+    acceptsLanguages(langs: string[]): string | boolean;
+    /**
+     * Check if the incoming request contains the "Content-Type"
+     * header field, and it contains any of the give mime `type`s.
+     * If there is no request body, `null` is returned.
+     * If there is no content type, `false` is returned.
+     * Otherwise, it returns the first `type` that matches.
+     *
+     * Examples:
+     *
+     *     // With Content-Type: text/html; charset=utf-8
+     *     this.is('html'); // => 'html'
+     *     this.is('text/html'); // => 'text/html'
+     *     this.is('text/*', 'application/json'); // => 'text/html'
+     *
+     *     // When Content-Type is application/json
+     *     this.is('json', 'urlencoded'); // => 'json'
+     *     this.is('application/json'); // => 'application/json'
+     *     this.is('html', 'application/*'); // => 'application/json'
+     *
+     *     this.is('html'); // => false
+     */
+    is(...types: string[]): string | boolean;
+    is(types: string[]): string | boolean;
+    /**
+     * Return request header. If the header is not set, will return an empty
+     * string.
+     *
+     * The `Referrer` header field is special-cased, both `Referrer` and
+     * `Referer` are interchangeable.
+     *
+     * Examples:
+     *
+     *     this.get('Content-Type');
+     *     // => "text/plain"
+     *
+     *     this.get('content-type');
+     *     // => "text/plain"
+     *
+     *     this.get('Something');
+     *     // => ''
+     */
+    get(field: string): string;
+    /**
+     * Get parsed host from event
+     */
+    host: string;
+    /**
+     * Get parsed host from event
+     */
+    hostname: string;
+    /**
+     * Request remote address.
+     */
+    ip: string;
+    /**
+     * Get/Set request URL.
+     */
+    url: string;
+    originalUrl: string;
+    accept: any;
+    /**
+     * Get request pathname.
+     */
+    path: string;
+    /**
+     * Get request method.
+     */
+    method: string;
+    /**
+     * Return request header.
+     */
+    header: {
+        [key: string]: string;
+    };
+    /**
+     * Return request header, alias as request.header
+     */
+    headers: {
+        [key: string]: string;
+    };
+    /**
+     * Get parsed query-string.
+     */
+    query: {
+        [key: string]: any;
+    };
+    /**
+     * Get parsed params
+     */
+    params: {
+        [key: string]: string;
+    };
+}
+export interface FaaSHTTPRequest extends ContextDelegatedRequest {
+    /**
+     * Get parsed request body from event
+     */
+    body: any;
+    /**
+     * Get Parsed path parameters from event
+     */
+    pathParameters: any;
+}
+interface ContextDelegatedResponse {
+    /**
+     * Get/Set response status code.
+     */
+    status: number;
+    /**
+     * Get/Set response body.
+     */
+    body: any;
+    /**
+     * Return parsed response Content-Length when present.
+     * Set Content-Length field to `n`.
+     */
+    length: number;
+    /**
+     * Return the response mime type void of
+     * parameters such as "charset".
+     *
+     * Set Content-Type response header with `type` through `mime.lookup()`
+     * when it does not contain a charset.
+     *
+     * Examples:
+     *
+     *     this.type = '.html';
+     *     this.type = 'html';
+     *     this.type = 'json';
+     *     this.type = 'application/json';
+     *     this.type = 'png';
+     */
+    type: string;
+    /**
+     * Get the Last-Modified date in Date form, if it exists.
+     * Set the Last-Modified date using a string or a Date.
+     *
+     *     this.response.lastModified = new Date();
+     *     this.response.lastModified = '2013-09-13';
+     */
+    lastModified: Date;
+    /**
+     * Get/Set the ETag of a response.
+     * This will normalize the quotes if necessary.
+     *
+     *     this.response.etag = 'md5hashsum';
+     *     this.response.etag = '"md5hashsum"';
+     *     this.response.etag = 'W/"123456789"';
+     *
+     * @param {String} etag
+     * @api public
+     */
+    etag: string;
+    /**
+     * Set header `field` to `val`, or pass
+     * an object of header fields.
+     *
+     * Examples:
+     *
+     *    this.set('Foo', ['bar', 'baz']);
+     *    this.set('Accept', 'application/json');
+     *    this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+     */
+    set(field: {
+        [key: string]: string;
+    }): void;
+    set(field: string, val: string | string[]): void;
+    /**
+     * Append additional header `field` with value `val`.
+     *
+     * Examples:
+     *
+     * ```
+     * this.append('Link', ['<http://localhost/>', '<http://localhost:3000/>']);
+     * this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly');
+     * this.append('Warning', '199 Miscellaneous warning');
+     * ```
+     */
+    append(field: string, val: string | string[]): void;
+    /**
+     * Remove header `field`.
+     */
+    remove(field: string): void;
+    /**
+     * Perform a 302 redirect to `url`.
+     *
+     * The string "back" is special-cased
+     * to provide Referrer support, when Referrer
+     * is not present `alt` or "/" is used.
+     *
+     * Examples:
+     *
+     *    this.redirect('back');
+     *    this.redirect('back', '/index.html');
+     *    this.redirect('/login');
+     *    this.redirect('http://google.com');
+     */
+    redirect(url: string, alt?: string): void;
+    /**
+     * Get/Set streaming response.
+     *
+     *     this.streaming = true;
+     *
+     * @api public
+     */
+    streaming: boolean;
+}
+export interface FaaSHTTPResponse extends ContextDelegatedResponse, Pick<Writable, 'write' | 'end'> {
+    /**
+     * Return response header.
+     */
+    header: {
+        [key: string]: any;
+    };
+    /**
+     * Return response header, alias as response.header
+     */
+    headers: {
+        [key: string]: any;
+    };
+    /**
+     * Check whether the response is one of the listed types.
+     * Pretty much the same as `this.request.is()`.
+     *
+     * @param {String|Array} types...
+     * @return {String|false}
+     * @api public
+     */
+    is(...types: string[]): string;
+    is(types: string[]): string;
+    /**
+     * Return response header. If the header is not set, will return an empty
+     * string.
+     *
+     * The `Referrer` header field is special-cased, both `Referrer` and
+     * `Referer` are interchangeable.
+     *
+     * Examples:
+     *
+     *     this.get('Content-Type');
+     *     // => "text/plain"
+     *
+     *     this.get('content-type');
+     *     // => "text/plain"
+     *
+     *     this.get('Something');
+     *     // => ''
+     */
+    get(field: string): string;
+}
+export interface FaaSHTTPContext extends ContextDelegatedRequest, ContextDelegatedResponse {
+    /**
+     * It's a http request mock object, please don't use it directly.
+     */
+    req: any;
+    /**
+     * It's a http response mock object, please don't use it directly.
+     */
+    res: any;
+    /**
+     * FaaS http request object
+     */
+    request: FaaSHTTPRequest;
+    /**
+     * FaaS http response object
+     */
+    response: FaaSHTTPResponse;
+    /**
+     * FaaS original event object.
+     */
+    originEvent: Record<string, any>;
+    /**
+     * FaaS Cookies Object
+     */
+    cookies: Cookies;
+    /**
+     * Throw an error with `msg` and optional `status`
+     * defaulting to 500. Note that these are user-level
+     * errors, and the message may be exposed to the client.
+     *
+     *    this.throw(403)
+     *    this.throw('name required', 400)
+     *    this.throw(400, 'name required')
+     *    this.throw('something exploded')
+     *    this.throw(new Error('invalid'), 400);
+     *    this.throw(400, new Error('invalid'));
+     *
+     * See: https://github.com/jshttp/http-errors
+     */
+    throw(message: string, code?: number, properties?: Record<string, unknown>): never;
+    throw(status: number): never;
+    throw(...properties: Array<number | string | Record<string, unknown>>): never;
+}
 export interface FaaSContext extends IMidwayContext<FaaSHTTPContext> {
     logger: ILogger;
     env: string;
@@ -92,4 +460,5 @@ export interface HttpResponseFormat<T = unknown> {
 }
 export interface wrapHttpRequestOptions extends HttpResponseOptions {
 }
+export {};
 //# sourceMappingURL=interface.d.ts.map

package/index.d.ts

@@ -1,2 +1,373 @@
-export * from '@midwayjs/faas-typings';
 export * from './dist/index';
+
+interface SingleOSSEvent {
+  eventName: string;
+  eventSource: string;
+  eventTime: string;
+  eventVersion: string;
+  oss: {
+    bucket: {
+      arn: string;
+      name: string;
+      ownerIdentity: string;
+      virtualBucket: string;
+    };
+    object: {
+      deltaSize: number;
+      eTag: string;
+      key: string;
+      size: number;
+    };
+    ossSchemaVersion: string;
+    ruleId: string;
+  };
+  region: string;
+  requestParameters: {
+    sourceIPAddress: string;
+  };
+  responseElements: {
+    requestId: string;
+  };
+  userIdentity: {
+    principalId: string;
+  };
+}
+
+interface SingleCDNEvent {
+  // 事件类型
+  eventName: string;
+  eventSource: string;
+  region: string;
+  eventVersion: string;
+  eventTime: string;
+  userIdentity: {
+    aliUid: string;
+  };
+  resource: {
+    domain: string;
+  };
+  eventParameter: {
+    domain: string;
+    endTime: number;
+    fileSize: number;
+    filePath: string;
+    startTime: number;
+  };
+  traceId: string;
+}
+
+interface MNSStreamEvent {
+  body: string;
+  attrs: {
+    Extend: string;
+  };
+}
+
+interface MNSJSONEvent {
+  Context: string;
+  TopicOwner: string;
+  Message: string;
+  Subscriber: string;
+  PublishTime: number;
+  SubscriptionName: string;
+  MessageMD5: string;
+  TopicName: string;
+  MessageId: string;
+}
+
+interface TableStoreRecord {
+  Type: 'string';
+  Info: {
+    Timestamp: number;
+  };
+  PrimaryKey: [
+    {
+      ColumnName: string;
+      Value: any;
+    }
+  ];
+  Columns: [
+    {
+      Type: string;
+      ColumnName: string;
+      Value: any;
+      Timestamp: number;
+    }
+  ];
+}
+
+/**
+ * @deprecated
+ */
+export namespace FC {
+  export interface OSSEvent {
+    events: SingleOSSEvent[];
+  }
+
+  export type MNSEvent = string | MNSStreamEvent | MNSJSONEvent;
+
+  export interface SLSEvent {
+    parameter: Record<string, unknown>;
+    source: {
+      endpoint: string;
+      projectName: string;
+      logstoreName: string;
+      shardId: number;
+      beginCursor: string;
+      endCursor: string;
+    };
+    jobName: string;
+    taskId: string;
+    cursorTime: number;
+  }
+
+  export interface CDNEvent {
+    events: SingleCDNEvent[];
+  }
+
+  export interface TimerEvent {
+    triggerTime: string;
+    triggerName: string;
+    payload: string;
+  }
+
+  export interface APIGatewayEvent {
+    path: string;
+    httpMethod: string;
+    headers: { [key: string]: string };
+    queryParameters: { [key: string]: string };
+    pathParameters: { [key: string]: string };
+    body: string;
+    isBase64Encoded: 'true' | 'false';
+  }
+
+  export interface APIGatewayResponse {
+    isBase64Encoded: boolean;
+    statusCode: number;
+    headers: Record<string, unknown>;
+    body: string;
+  }
+
+  export interface TableStoreEvent {
+    Version: string;
+    Records: TableStoreRecord[];
+  }
+
+  export interface InitializeContext {
+    requestId: string;
+    credentials: {
+      accessKeyId: string;
+      accessKeySecret: string;
+      securityToken: string;
+    };
+    function: {
+      name: string;
+      handler: string;
+      memory: number;
+      timeout: number;
+      initializer: string;
+      initializationTimeout: number;
+    };
+    service: {
+      name: string;
+      logProject: string;
+      logStore: string;
+      qualifier: string;
+      versionId: string;
+    };
+    region: string;
+    accountId: string;
+    logger: Console;
+  }
+
+  export type RequestContext = InitializeContext;
+}
+
+interface COSRecord {
+  cos: {
+    cosSchemaVersion: string;
+    cosObject: {
+      url: string;
+      meta: {
+        'x-cos-request-id': string;
+        'Content-Type': string;
+      };
+      vid: string;
+      key: string;
+      size: number;
+    };
+    cosBucket: {
+      region: string;
+      name: string;
+      appid: string;
+    };
+    cosNotificationId: string;
+  };
+  event: {
+    eventName: string;
+    eventVersion: string;
+    eventTime: number;
+    eventSource: string;
+    requestParameters: {
+      requestSourceIP: string;
+      requestHeaders: {
+        Authorization: string;
+      };
+    };
+    eventQueue: string;
+    reservedInfo: string;
+    reqid: number;
+  };
+}
+
+interface CMQRecord {
+  CMQ: {
+    type: string;
+    topicOwner: number;
+    topicName: string;
+    subscriptionName: string;
+    publishTime: string;
+    msgId: string;
+    requestId: string;
+    msgBody: string;
+    msgTag: string;
+  };
+}
+
+interface CKafkaRecord {
+  Ckafka: {
+    topic: string;
+    partition: number;
+    offset: number;
+    msgKey: string;
+    msgBody: string;
+  };
+}
+
+/**
+ * @deprecated
+ */
+export namespace SCF {
+  export interface COSEvent {
+    Records: COSRecord[];
+  }
+
+  export interface TimerEvent {
+    Type: string;
+    TriggerName: string;
+    Time: string;
+    Message: string;
+  }
+
+  export interface CMQEvent {
+    Records: CMQRecord[];
+  }
+
+  export interface CKafkaEvent {
+    Records: CKafkaRecord[];
+  }
+
+  export interface APIGatewayEvent {
+    /**
+     * 请求来源的 API 网关的配置信息、请求标识、认证信息、来源信息。其中：
+     * serviceId，path，httpMethod 指向 API 网关的服务Id、API 的路径和方法；
+     * stage 指向请求来源 API 所在的环境；
+     * requestId 标识当前这次请求的唯一 ID；
+     * identity 标识用户的认证方法和认证的信息；
+     * sourceIp 标识请求来源 IP
+     */
+    requestContext: {
+      serviceId: string;
+      path: string;
+      httpMethod: string;
+      requestId: string;
+      identity: {
+        secretId: string;
+      };
+      sourceIp: string;
+      stage: string;
+    };
+    /**
+     * 记录实际请求的完整 Header 内容
+     */
+    headers: Record<string, unknown>;
+    /**
+     * 记录实际请求的完整 Body 内容
+     */
+    body: string;
+    /**
+     * 记录在 API 网关中配置过的 Path 参数以及实际取值
+     */
+    pathParameters: Record<string, unknown>;
+    /**
+     * 记录在 API 网关中配置过的 Query 参数以及实际取值
+     */
+    queryStringParameters: Record<string, unknown>;
+    /**
+     * 记录在 API 网关中配置过的 Header 参数以及实际取值
+     */
+    headerParameters: Record<string, unknown>;
+    stageVariables: {
+      stage: string;
+    };
+    /**
+     * 记录实际请求的完整 Path 信息，注意 midway faas 为了获取真实 path 做过处理
+     */
+    path: string;
+    /**
+     * 请求地址的查询参数
+     */
+    queryString: Record<string, unknown>;
+    httpMethod: string;
+  }
+
+  export interface APIGatewayResponse {
+    isBase64Encoded: boolean;
+    statusCode: number;
+    headers: Record<string, unknown>;
+    body: string;
+  }
+
+  export interface APIGatewayWebSocketEvent {
+    requestContext: {
+      serviceName: string;
+      path: string;
+      httpMethod: string;
+      requestId: string;
+      identity: {
+        secretId: string;
+      };
+      sourceIp: string;
+      stage: string;
+      websocketEnable: boolean;
+    };
+    websocket: {
+      action: string;
+      secConnectionID: string;
+      secWebSocketProtocol: string;
+      secWebSocketExtensions: string;
+    };
+  }
+
+  export interface APIGatewayWebSocketResponse {
+    errNo: number;
+    errMsg: string;
+    websocket: {
+      action: string;
+      secConnectionID: string;
+      secWebSocketProtocol: string;
+      secWebSocketExtensions: string;
+    };
+  }
+
+  export interface RequestContext {
+    callbackWaitsForEmptyEventLoop: boolean;
+    memory_limit_in_mb: number;
+    time_limit_in_ms: number;
+    request_id: string;
+    environ: string;
+    function_version: string;
+    function_name: string;
+    namespace: string;
+  }
+}

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@midwayjs/faas",
-  "version": "3.12.3",
-  "main": "dist/index",
+  "version": "3.12.5",
+  "main": "dist/index.js",
   "typings": "index.d.ts",
   "dependencies": {
     "@midwayjs/core": "^3.12.3",
-    "@midwayjs/faas-typings": "^3.10.13",
     "@midwayjs/logger": "^2.15.0",
-    "@midwayjs/serverless-http-parser": "^3.10.14",
+    "@midwayjs/serverless-http-parser": "^3.12.5",
     "@midwayjs/simple-lock": "^1.1.4"
   },
   "devDependencies": {
     "@midwayjs/mock": "^3.12.3",
-    "@midwayjs/serverless-fc-starter": "^3.12.3",
-    "@midwayjs/serverless-scf-starter": "^3.10.14",
+    "@midwayjs/serverless-fc-starter": "^3.12.5",
+    "@midwayjs/serverless-scf-starter": "^3.12.5",
     "mm": "3.3.0"
   },
   "engines": {
@@ -45,5 +44,5 @@
     "url": "git@github.com:midwayjs/midway.git"
   },
   "license": "MIT",
-  "gitHead": "0b6638726c4722d5a6ee8075fea0a0b68378452c"
+  "gitHead": "24c6b9f7a3be1bf37b3182286f3e55fc418a2c99"
 }