@aomex/cors 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @aomex/cors
2
2
 
3
+ ## 1.0.2
4
+
5
+ ## 1.0.1
6
+
3
7
  ## 1.0.0
4
8
 
5
9
  ### Minor Changes
package/dist/index.js CHANGED
@@ -26,8 +26,7 @@ var cors = (options = {}) => {
26
26
  } else {
27
27
  origin = options.origin || requestOrigin;
28
28
  }
29
- if (!origin)
30
- return next();
29
+ if (!origin) return next();
31
30
  let credentials;
32
31
  if (typeof options.credentials === "function") {
33
32
  credentials = await options.credentials(ctx);
@@ -35,8 +34,7 @@ var cors = (options = {}) => {
35
34
  credentials = !!options.credentials;
36
35
  }
37
36
  if (request.method === "OPTIONS") {
38
- if (!request.headers["access-control-request-method"])
39
- return next();
37
+ if (!request.headers["access-control-request-method"]) return next();
40
38
  response.setHeader("Access-Control-Allow-Origin", origin);
41
39
  credentials && response.setHeader("Access-Control-Allow-Credentials", "true");
42
40
  options.maxAge && response.setHeader("Access-Control-Max-Age", options.maxAge);
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { HttpError, WebContext, WebMiddleware } from '@aomex/web';\nimport { middleware } from '@aomex/core';\nimport vary from 'vary';\n\nexport interface CorsOptions {\n /**\n * 设置报头Access-Control-Allow-Origin,表示该响应的资源是否被允许与给定的来源(origin)共享。对于不包含凭据的请求,也可以设为星号(\\*),表示同意任意跨源请求\n */\n origin?:\n | ((ctx: WebContext) => string | undefined | Promise<string | undefined>)\n | string;\n\n /**\n * 设置报头Access-Control-Allow-Methods,表示客户端所要访问的资源允许使用的方法或方法列表。\n * 默认值:`GET,HEAD,PUT,POST,DELETE,PATCH`\n */\n allowMethods?: string[] | string;\n\n /**\n * 响应报头 Access-Control-Expose-Headers 允许服务器指示那些响应报头可以暴露给浏览器中运行的脚本。\n * 默认情况下,只暴露安全列表的响应报头:\n * - Cache-Control\n * - Content-Language\n * - Content-Length\n * - Content-Type\n * - Expires\n * - Last-Modified\n * - Pragma\n *\n *\n * ```typescript\n * cors({\n * exposeHeaders: ['Content-Encoding', 'Kuma-Revision'],\n * });\n * ```\n *\n * 更多详细信息请参考[MDN](https://developer.mozilla.org/zh_CN/docs/Web/HTTP/Headers/Access-Control-Expose-Headers)\n */\n exposeHeaders?: string[] | string;\n\n /**\n * `Access-Control-Allow-Headers`\n */\n allowHeaders?: string[] | string;\n\n /**\n * 设置报头Access-Control-Max-Age,表示 Access-Control-Allow-Methods 和 Access-Control-Allow-Headers 提供的信息可以被缓存的最长时间(秒)\n *\n * 如果值为`-1`,表示禁用缓存,则每次请求前都需要使用 OPTIONS 预检请求\n */\n maxAge?: number | string;\n\n /**\n * 设置报头Access-Control-Allow-Credentials,Credentials可以代表 cookies、authorization headers 或 TLS client certificates,需要与客户端 XMLHttpRequest.withCredentials 或 Fetch API 的 credentials 选项结合使用\n */\n credentials?: ((ctx: WebContext) => boolean | Promise<boolean>) | boolean;\n\n /**\n * 响应头部增加 `Cross-Origin-Opener-Policy` 和 `Cross-Origin-Embedder-Policy` 这两个个报头。默认值:`false`\n *\n * @see https://developer.mozilla.org/en_US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer/Planned_changes\n */\n secureContext?: boolean;\n\n /**\n * 处理请求报头 `Access-Control-Request-Private-Network` 并返回报头`Access-Control-Allow-Private-Network`。默认值:`false`\n *\n * @link https://github.com/WICG/private-network-access\n */\n privateNetworkAccess?: boolean;\n}\n\n/**\n * `CORS`,全称Cross-Origin Resource Sharing,是一种允许当前域(domain)的资源(比如html/js/web service)被其他域(domain)的脚本请求访问的机制,通常由于同域安全策略(the same-origin security policy),浏览器会禁止跨域请求。\n */\nexport const cors = (options: CorsOptions = {}): WebMiddleware => {\n options = {\n allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH',\n secureContext: false,\n ...options,\n };\n\n (<const>['exposeHeaders', 'allowMethods', 'allowHeaders']).forEach((key) => {\n const value = options[key];\n if (Array.isArray(value)) {\n options[key] = value.join(',');\n }\n });\n\n if (options.maxAge) {\n options.maxAge = String(options.maxAge);\n }\n\n return middleware.web(async (ctx, next) => {\n const { request, response } = ctx;\n const requestOrigin = request.headers['origin'];\n\n // 如果服务器未使用通配符“*”,而是指定了明确的来源,那么为了向客户端表明服务器的返回会根据 Origin 请求报头而有所不同,必须在 Vary 响应报头中包含 Origin\n response.vary('Origin');\n\n let origin: string | undefined;\n if (typeof options.origin === 'function') {\n origin = await options.origin(ctx);\n } else {\n origin = options.origin || requestOrigin;\n }\n if (!origin) return next();\n\n let credentials: boolean;\n if (typeof options.credentials === 'function') {\n credentials = await options.credentials(ctx);\n } else {\n credentials = !!options.credentials;\n }\n\n if (request.method === 'OPTIONS') {\n if (!request.headers['access-control-request-method']) return next();\n\n response.setHeader('Access-Control-Allow-Origin', origin);\n credentials && response.setHeader('Access-Control-Allow-Credentials', 'true');\n options.maxAge && response.setHeader('Access-Control-Max-Age', options.maxAge);\n options.privateNetworkAccess &&\n request.headers['access-control-request-private-network'] &&\n response.setHeader('Access-Control-Allow-Private-Network', 'true');\n options.allowMethods &&\n response.setHeader('Access-Control-Allow-Methods', options.allowMethods);\n if (options.secureContext) {\n response.setHeader('Cross-Origin-Opener-Policy', 'same-origin');\n response.setHeader('Cross-Origin-Embedder-Policy', 'require-corp');\n }\n const allowHeaders =\n options.allowHeaders || request.headers['access-control-request-headers'];\n if (allowHeaders) {\n response.setHeader('Access-Control-Allow-Headers', allowHeaders);\n }\n\n return ctx.send(204);\n }\n\n const corsHeaders: Record<string, any> = {};\n function setAndRecordHeader(key: string, value: any) {\n response.setHeader(key, value);\n corsHeaders[key] = value;\n }\n\n setAndRecordHeader('Access-Control-Allow-Origin', origin);\n credentials && setAndRecordHeader('Access-Control-Allow-Credentials', 'true');\n options.exposeHeaders &&\n setAndRecordHeader('Access-Control-Expose-Headers', options.exposeHeaders);\n if (options.secureContext) {\n setAndRecordHeader('Cross-Origin-Opener-Policy', 'same-origin');\n setAndRecordHeader('Cross-Origin-Embedder-Policy', 'require-corp');\n }\n\n return next().catch((err: HttpError) => {\n const errHeaders = err.headers || {};\n const varyWithOrigin = vary.append(\n errHeaders['vary'] || errHeaders['Vary'] || '',\n 'Origin',\n );\n delete errHeaders['Vary'];\n err.headers = {\n ...errHeaders,\n ...corsHeaders,\n ...{ vary: varyWithOrigin },\n };\n return Promise.reject(err);\n });\n });\n};\n"],"mappings":";AACA,SAAS,kBAAkB;AAC3B,OAAO,UAAU;AAyEV,IAAM,OAAO,CAAC,UAAuB,CAAC,MAAqB;AAChE,YAAU;AAAA,IACR,cAAc;AAAA,IACd,eAAe;AAAA,IACf,GAAG;AAAA,EACL;AAEA,EAAQ,CAAC,iBAAiB,gBAAgB,cAAc,EAAG,QAAQ,CAAC,QAAQ;AAC1E,UAAM,QAAQ,QAAQ,GAAG;AACzB,QAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,cAAQ,GAAG,IAAI,MAAM,KAAK,GAAG;AAAA,IAC/B;AAAA,EACF,CAAC;AAED,MAAI,QAAQ,QAAQ;AAClB,YAAQ,SAAS,OAAO,QAAQ,MAAM;AAAA,EACxC;AAEA,SAAO,WAAW,IAAI,OAAO,KAAK,SAAS;AACzC,UAAM,EAAE,SAAS,SAAS,IAAI;AAC9B,UAAM,gBAAgB,QAAQ,QAAQ,QAAQ;AAG9C,aAAS,KAAK,QAAQ;AAEtB,QAAI;AACJ,QAAI,OAAO,QAAQ,WAAW,YAAY;AACxC,eAAS,MAAM,QAAQ,OAAO,GAAG;AAAA,IACnC,OAAO;AACL,eAAS,QAAQ,UAAU;AAAA,IAC7B;AACA,QAAI,CAAC;AAAQ,aAAO,KAAK;AAEzB,QAAI;AACJ,QAAI,OAAO,QAAQ,gBAAgB,YAAY;AAC7C,oBAAc,MAAM,QAAQ,YAAY,GAAG;AAAA,IAC7C,OAAO;AACL,oBAAc,CAAC,CAAC,QAAQ;AAAA,IAC1B;AAEA,QAAI,QAAQ,WAAW,WAAW;AAChC,UAAI,CAAC,QAAQ,QAAQ,+BAA+B;AAAG,eAAO,KAAK;AAEnE,eAAS,UAAU,+BAA+B,MAAM;AACxD,qBAAe,SAAS,UAAU,oCAAoC,MAAM;AAC5E,cAAQ,UAAU,SAAS,UAAU,0BAA0B,QAAQ,MAAM;AAC7E,cAAQ,wBACN,QAAQ,QAAQ,wCAAwC,KACxD,SAAS,UAAU,wCAAwC,MAAM;AACnE,cAAQ,gBACN,SAAS,UAAU,gCAAgC,QAAQ,YAAY;AACzE,UAAI,QAAQ,eAAe;AACzB,iBAAS,UAAU,8BAA8B,aAAa;AAC9D,iBAAS,UAAU,gCAAgC,cAAc;AAAA,MACnE;AACA,YAAM,eACJ,QAAQ,gBAAgB,QAAQ,QAAQ,gCAAgC;AAC1E,UAAI,cAAc;AAChB,iBAAS,UAAU,gCAAgC,YAAY;AAAA,MACjE;AAEA,aAAO,IAAI,KAAK,GAAG;AAAA,IACrB;AAEA,UAAM,cAAmC,CAAC;AAC1C,aAAS,mBAAmB,KAAa,OAAY;AACnD,eAAS,UAAU,KAAK,KAAK;AAC7B,kBAAY,GAAG,IAAI;AAAA,IACrB;AAEA,uBAAmB,+BAA+B,MAAM;AACxD,mBAAe,mBAAmB,oCAAoC,MAAM;AAC5E,YAAQ,iBACN,mBAAmB,iCAAiC,QAAQ,aAAa;AAC3E,QAAI,QAAQ,eAAe;AACzB,yBAAmB,8BAA8B,aAAa;AAC9D,yBAAmB,gCAAgC,cAAc;AAAA,IACnE;AAEA,WAAO,KAAK,EAAE,MAAM,CAAC,QAAmB;AACtC,YAAM,aAAa,IAAI,WAAW,CAAC;AACnC,YAAM,iBAAiB,KAAK;AAAA,QAC1B,WAAW,MAAM,KAAK,WAAW,MAAM,KAAK;AAAA,QAC5C;AAAA,MACF;AACA,aAAO,WAAW,MAAM;AACxB,UAAI,UAAU;AAAA,QACZ,GAAG;AAAA,QACH,GAAG;AAAA,QACH,GAAG,EAAE,MAAM,eAAe;AAAA,MAC5B;AACA,aAAO,QAAQ,OAAO,GAAG;AAAA,IAC3B,CAAC;AAAA,EACH,CAAC;AACH;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { HttpError, WebContext, WebMiddleware } from '@aomex/web';\nimport { middleware } from '@aomex/core';\nimport vary from 'vary';\n\nexport interface CorsOptions {\n /**\n * 设置报头Access-Control-Allow-Origin,表示该响应的资源是否被允许与给定的来源(origin)共享。对于不包含凭据的请求,也可以设为星号(\\*),表示同意任意跨源请求\n */\n origin?:\n | ((ctx: WebContext) => string | undefined | Promise<string | undefined>)\n | string;\n\n /**\n * 设置报头Access-Control-Allow-Methods,表示客户端所要访问的资源允许使用的方法或方法列表。\n * 默认值:`GET,HEAD,PUT,POST,DELETE,PATCH`\n */\n allowMethods?: string[] | string;\n\n /**\n * 响应报头 Access-Control-Expose-Headers 允许服务器指示那些响应报头可以暴露给浏览器中运行的脚本。\n * 默认情况下,只暴露安全列表的响应报头:\n * - Cache-Control\n * - Content-Language\n * - Content-Length\n * - Content-Type\n * - Expires\n * - Last-Modified\n * - Pragma\n *\n *\n * ```typescript\n * cors({\n * exposeHeaders: ['Content-Encoding', 'Kuma-Revision'],\n * });\n * ```\n *\n * 更多详细信息请参考[MDN](https://developer.mozilla.org/zh_CN/docs/Web/HTTP/Headers/Access-Control-Expose-Headers)\n */\n exposeHeaders?: string[] | string;\n\n /**\n * `Access-Control-Allow-Headers`\n */\n allowHeaders?: string[] | string;\n\n /**\n * 设置报头Access-Control-Max-Age,表示 Access-Control-Allow-Methods 和 Access-Control-Allow-Headers 提供的信息可以被缓存的最长时间(秒)\n *\n * 如果值为`-1`,表示禁用缓存,则每次请求前都需要使用 OPTIONS 预检请求\n */\n maxAge?: number | string;\n\n /**\n * 设置报头Access-Control-Allow-Credentials,Credentials可以代表 cookies、authorization headers 或 TLS client certificates,需要与客户端 XMLHttpRequest.withCredentials 或 Fetch API 的 credentials 选项结合使用\n */\n credentials?: ((ctx: WebContext) => boolean | Promise<boolean>) | boolean;\n\n /**\n * 响应头部增加 `Cross-Origin-Opener-Policy` 和 `Cross-Origin-Embedder-Policy` 这两个个报头。默认值:`false`\n *\n * @see https://developer.mozilla.org/en_US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer/Planned_changes\n */\n secureContext?: boolean;\n\n /**\n * 处理请求报头 `Access-Control-Request-Private-Network` 并返回报头`Access-Control-Allow-Private-Network`。默认值:`false`\n *\n * @link https://github.com/WICG/private-network-access\n */\n privateNetworkAccess?: boolean;\n}\n\n/**\n * `CORS`,全称Cross-Origin Resource Sharing,是一种允许当前域(domain)的资源(比如html/js/web service)被其他域(domain)的脚本请求访问的机制,通常由于同域安全策略(the same-origin security policy),浏览器会禁止跨域请求。\n */\nexport const cors = (options: CorsOptions = {}): WebMiddleware => {\n options = {\n allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH',\n secureContext: false,\n ...options,\n };\n\n (<const>['exposeHeaders', 'allowMethods', 'allowHeaders']).forEach((key) => {\n const value = options[key];\n if (Array.isArray(value)) {\n options[key] = value.join(',');\n }\n });\n\n if (options.maxAge) {\n options.maxAge = String(options.maxAge);\n }\n\n return middleware.web(async (ctx, next) => {\n const { request, response } = ctx;\n const requestOrigin = request.headers['origin'];\n\n // 如果服务器未使用通配符“*”,而是指定了明确的来源,那么为了向客户端表明服务器的返回会根据 Origin 请求报头而有所不同,必须在 Vary 响应报头中包含 Origin\n response.vary('Origin');\n\n let origin: string | undefined;\n if (typeof options.origin === 'function') {\n origin = await options.origin(ctx);\n } else {\n origin = options.origin || requestOrigin;\n }\n if (!origin) return next();\n\n let credentials: boolean;\n if (typeof options.credentials === 'function') {\n credentials = await options.credentials(ctx);\n } else {\n credentials = !!options.credentials;\n }\n\n if (request.method === 'OPTIONS') {\n if (!request.headers['access-control-request-method']) return next();\n\n response.setHeader('Access-Control-Allow-Origin', origin);\n credentials && response.setHeader('Access-Control-Allow-Credentials', 'true');\n options.maxAge && response.setHeader('Access-Control-Max-Age', options.maxAge);\n options.privateNetworkAccess &&\n request.headers['access-control-request-private-network'] &&\n response.setHeader('Access-Control-Allow-Private-Network', 'true');\n options.allowMethods &&\n response.setHeader('Access-Control-Allow-Methods', options.allowMethods);\n if (options.secureContext) {\n response.setHeader('Cross-Origin-Opener-Policy', 'same-origin');\n response.setHeader('Cross-Origin-Embedder-Policy', 'require-corp');\n }\n const allowHeaders =\n options.allowHeaders || request.headers['access-control-request-headers'];\n if (allowHeaders) {\n response.setHeader('Access-Control-Allow-Headers', allowHeaders);\n }\n\n return ctx.send(204);\n }\n\n const corsHeaders: Record<string, any> = {};\n function setAndRecordHeader(key: string, value: any) {\n response.setHeader(key, value);\n corsHeaders[key] = value;\n }\n\n setAndRecordHeader('Access-Control-Allow-Origin', origin);\n credentials && setAndRecordHeader('Access-Control-Allow-Credentials', 'true');\n options.exposeHeaders &&\n setAndRecordHeader('Access-Control-Expose-Headers', options.exposeHeaders);\n if (options.secureContext) {\n setAndRecordHeader('Cross-Origin-Opener-Policy', 'same-origin');\n setAndRecordHeader('Cross-Origin-Embedder-Policy', 'require-corp');\n }\n\n return next().catch((err: HttpError) => {\n const errHeaders = err.headers || {};\n const varyWithOrigin = vary.append(\n errHeaders['vary'] || errHeaders['Vary'] || '',\n 'Origin',\n );\n delete errHeaders['Vary'];\n err.headers = {\n ...errHeaders,\n ...corsHeaders,\n ...{ vary: varyWithOrigin },\n };\n return Promise.reject(err);\n });\n });\n};\n"],"mappings":";AACA,SAAS,kBAAkB;AAC3B,OAAO,UAAU;AAyEV,IAAM,OAAO,CAAC,UAAuB,CAAC,MAAqB;AAChE,YAAU;AAAA,IACR,cAAc;AAAA,IACd,eAAe;AAAA,IACf,GAAG;AAAA,EACL;AAEA,EAAQ,CAAC,iBAAiB,gBAAgB,cAAc,EAAG,QAAQ,CAAC,QAAQ;AAC1E,UAAM,QAAQ,QAAQ,GAAG;AACzB,QAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,cAAQ,GAAG,IAAI,MAAM,KAAK,GAAG;AAAA,IAC/B;AAAA,EACF,CAAC;AAED,MAAI,QAAQ,QAAQ;AAClB,YAAQ,SAAS,OAAO,QAAQ,MAAM;AAAA,EACxC;AAEA,SAAO,WAAW,IAAI,OAAO,KAAK,SAAS;AACzC,UAAM,EAAE,SAAS,SAAS,IAAI;AAC9B,UAAM,gBAAgB,QAAQ,QAAQ,QAAQ;AAG9C,aAAS,KAAK,QAAQ;AAEtB,QAAI;AACJ,QAAI,OAAO,QAAQ,WAAW,YAAY;AACxC,eAAS,MAAM,QAAQ,OAAO,GAAG;AAAA,IACnC,OAAO;AACL,eAAS,QAAQ,UAAU;AAAA,IAC7B;AACA,QAAI,CAAC,OAAQ,QAAO,KAAK;AAEzB,QAAI;AACJ,QAAI,OAAO,QAAQ,gBAAgB,YAAY;AAC7C,oBAAc,MAAM,QAAQ,YAAY,GAAG;AAAA,IAC7C,OAAO;AACL,oBAAc,CAAC,CAAC,QAAQ;AAAA,IAC1B;AAEA,QAAI,QAAQ,WAAW,WAAW;AAChC,UAAI,CAAC,QAAQ,QAAQ,+BAA+B,EAAG,QAAO,KAAK;AAEnE,eAAS,UAAU,+BAA+B,MAAM;AACxD,qBAAe,SAAS,UAAU,oCAAoC,MAAM;AAC5E,cAAQ,UAAU,SAAS,UAAU,0BAA0B,QAAQ,MAAM;AAC7E,cAAQ,wBACN,QAAQ,QAAQ,wCAAwC,KACxD,SAAS,UAAU,wCAAwC,MAAM;AACnE,cAAQ,gBACN,SAAS,UAAU,gCAAgC,QAAQ,YAAY;AACzE,UAAI,QAAQ,eAAe;AACzB,iBAAS,UAAU,8BAA8B,aAAa;AAC9D,iBAAS,UAAU,gCAAgC,cAAc;AAAA,MACnE;AACA,YAAM,eACJ,QAAQ,gBAAgB,QAAQ,QAAQ,gCAAgC;AAC1E,UAAI,cAAc;AAChB,iBAAS,UAAU,gCAAgC,YAAY;AAAA,MACjE;AAEA,aAAO,IAAI,KAAK,GAAG;AAAA,IACrB;AAEA,UAAM,cAAmC,CAAC;AAC1C,aAAS,mBAAmB,KAAa,OAAY;AACnD,eAAS,UAAU,KAAK,KAAK;AAC7B,kBAAY,GAAG,IAAI;AAAA,IACrB;AAEA,uBAAmB,+BAA+B,MAAM;AACxD,mBAAe,mBAAmB,oCAAoC,MAAM;AAC5E,YAAQ,iBACN,mBAAmB,iCAAiC,QAAQ,aAAa;AAC3E,QAAI,QAAQ,eAAe;AACzB,yBAAmB,8BAA8B,aAAa;AAC9D,yBAAmB,gCAAgC,cAAc;AAAA,IACnE;AAEA,WAAO,KAAK,EAAE,MAAM,CAAC,QAAmB;AACtC,YAAM,aAAa,IAAI,WAAW,CAAC;AACnC,YAAM,iBAAiB,KAAK;AAAA,QAC1B,WAAW,MAAM,KAAK,WAAW,MAAM,KAAK;AAAA,QAC5C;AAAA,MACF;AACA,aAAO,WAAW,MAAM;AACxB,UAAI,UAAU;AAAA,QACZ,GAAG;AAAA,QACH,GAAG;AAAA,QACH,GAAG,EAAE,MAAM,eAAe;AAAA,MAC5B;AACA,aAAO,QAAQ,OAAO,GAAG;AAAA,IAC3B,CAAC;AAAA,EACH,CAAC;AACH;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aomex/cors",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "跨站资源共享",
5
5
  "repository": "git@github.com:aomex/aomex.git",
6
6
  "homepage": "https://aomex.js.org",
@@ -31,8 +31,8 @@
31
31
  },
32
32
  "devDependencies": {
33
33
  "@types/vary": "^1.1.3",
34
- "@aomex/core": "^1.0.0",
35
- "@aomex/web": "^1.0.0"
34
+ "@aomex/core": "^1.0.2",
35
+ "@aomex/web": "^1.0.2"
36
36
  },
37
37
  "dependencies": {
38
38
  "vary": "^1.1.2"