@nocobase/plugin-api-keys 0.14.0-alpha.7 → 0.14.0-alpha.8

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.
@@ -3,4 +3,4 @@
3
3
  & > .ant-space-item {
4
4
  flex: 1;
5
5
  }
6
- `,F=n=>{const{onChange:s}=n,[l,{toggle:u,setFalse:x}]=C.useBoolean(),g=p=>{if(p==="custom")return s("1d"),u();x(),s(p)},A=p=>{p=p.millisecond(0).second(0);const v=d().millisecond(0).second(0),f=`${p.diff(v,"d")}d`;s(f)};return e.jsxs(a.Space,{className:q,children:[e.jsx(a.Select,I(w({"data-testid":"antd-select"},n),{value:l?"custom":n.value,onChange:g})),l?e.jsx(a.DatePicker,{disabledDate:p=>p.isSameOrBefore(),defaultValue:K,onChange:A,showToday:!1,allowClear:!1}):null]})},V=()=>{const{expiresIn:n,createdAt:s}=t.useRecord(),{t:l}=b(),u=y.useMemo(()=>n==="never"?l("Never expires"):d(s).add((n==null?void 0:n.replace("d",""))||0,"days").format("YYYY-MM-DD HH:mm:ss"),[s,n]);return e.jsx(a.Typography.Text,{children:u})},B=c.connect(F,c.mapProps({dataSource:"options"}),c.mapReadPretty(V)),{useModal:j}=a.Modal,N=()=>{const n=c.useForm(),{setVisible:s}=t.useActionContext(),{resource:l,service:u}=t.useBlockRequestContext(),{t:x}=b(),[g,A]=j();return{run(){return h(this,null,function*(){var f,P;yield n.submit();const v=yield l.create({values:n.values});g.success({title:x("API key created successfully"),onOk:()=>{n.reset(),s(!1)},content:e.jsxs(a.Space,{direction:"vertical",children:[e.jsx(a.Alert,{message:x("Make sure to copy your personal access key now as you will not be able to see this again."),type:"warning"}),e.jsx(a.Typography.Text,{copyable:!0,children:(P=(f=v.data)==null?void 0:f.data)==null?void 0:P.token})]})}),u==null||u.refresh()})},element:A}},O=()=>{const n=t.useRecord(),{resource:s,service:l}=t.useBlockRequestContext();return{run(){return h(this,null,function*(){yield s.destroy({filterByTk:n.id}),l.refresh()})}}},E={type:"object",properties:{configuration:{type:"void","x-decorator":"TableBlockProvider","x-decorator-props":{collection:"apiKeys",resource:"apiKeys",action:"list",params:{pageSize:20,appends:["role"],sort:["-createdAt"]},rowKey:"name",showIndex:!0},"x-component":"CardItem",properties:{actions:{type:"void","x-component":"ActionBar","x-component-props":{style:{marginBottom:"var(--nb-spacing)"}},properties:{create:{type:"void","x-action":"create",title:r("Add API key"),"x-component":"Action","x-component-props":{openMode:"drawer",type:"primary"},properties:{drawer:{type:"void",title:r("Add API key"),"x-decorator":"Form","x-component":"Action.Modal","x-component-props":{maskClosable:!1,style:{maxWidth:"520px",width:"100%"}},properties:{name:{type:"string",title:r("Key name"),required:!0,"x-component":"CollectionField","x-decorator":"FormItem"},role:{type:"string",title:r("Role"),required:!0,"x-decorator-props":{tooltip:r("Allow only your own roles to be selected")},"x-collection-field":"apiKeys.role","x-component":"CollectionField","x-decorator":"FormItem"},expiresIn:{type:"string",title:r("Expiration"),required:!0,"x-component":"CollectionField","x-decorator":"FormItem",default:"30d"},footer:{type:"void","x-component":"Action.Modal.Footer",properties:{cancel:{title:'{{t("Cancel")}}',"x-component":"Action","x-component-props":{useAction:"{{ cm.useCancelAction }}"}},submit:{title:'{{t("Submit")}}',"x-component":"Action","x-component-props":{type:"primary",useAction:N}}}}}}},"x-align":"right"}}},[m.uid()]:{type:"array","x-component":"TableV2","x-component-props":{rowKey:"id",useProps:"{{ useTableBlockProps }}"},properties:{column1:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Key name"),properties:{name:{type:"string","x-component":"CollectionField","x-read-pretty":!0}}},column2:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Role"),properties:{role:{type:"object","x-collection-field":"apiKeys.role","x-component":"CollectionField","x-component-props":{enableLink:!1},"x-read-pretty":!0}}},column3:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Expiration"),properties:{expiresIn:{type:"string","x-component":"CollectionField","x-read-pretty":!0}}},column4:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Created at"),properties:{createdAt:{type:"date","x-component":"DatePicker","x-component-props":{format:"YYYY-MM-DD HH:mm:ss"},"x-read-pretty":!0}}},actionColumn:{type:"void",title:'{{ t("Actions") }}',"x-action-column":"actions","x-decorator":"TableV2.Column.ActionBar","x-component":"TableV2.Column",properties:{columnActions:{type:"void","x-component":"Space","x-component-props":{split:"|"},properties:{delete:{type:"void",title:'{{ t("Delete") }}',"x-component":"Action.Link","x-component-props":{confirm:{title:r("Delete API key"),content:"{{t('Are you sure you want to delete it?')}}"},useAction:O}}}}}}}}}}}},Y=()=>{const n=t.useCurrentRoles();return e.jsx(t.CollectionManagerProvider,{collections:[M],children:e.jsx(t.SchemaComponentOptions,{scope:{currentRoles:n},components:{ExpiresSelect:B},children:e.jsx(c.RecursionField,{schema:E})})})},T=y.memo(n=>{const{t:s}=b();return e.jsx(t.SettingsCenterProvider,{settings:{"api-keys":{title:s("API keys"),icon:"EnvironmentOutlined",tabs:{configuration:{title:s("Keys manager"),component:Y}}}},children:e.jsx(t.SchemaComponentOptions,{components:{},children:n.children})})});T.displayName="ApiKeysProvider";class H extends t.Plugin{load(){return h(this,null,function*(){this.app.addProvider(T)})}}o.default=H,Object.defineProperties(o,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
6
+ `,F=n=>{const{onChange:s}=n,[l,{toggle:u,setFalse:x}]=C.useBoolean(),g=p=>{if(p==="custom")return s("1d"),u();x(),s(p)},A=p=>{p=p.millisecond(0).second(0);const v=d().millisecond(0).second(0),f=`${p.diff(v,"d")}d`;s(f)};return e.jsxs(a.Space,{className:q,children:[e.jsx(a.Select,I(w({},n),{value:l?"custom":n.value,onChange:g})),l?e.jsx(a.DatePicker,{disabledDate:p=>p.isSameOrBefore(),defaultValue:K,onChange:A,showToday:!1,allowClear:!1}):null]})},V=()=>{const{expiresIn:n,createdAt:s}=t.useRecord(),{t:l}=b(),u=y.useMemo(()=>n==="never"?l("Never expires"):d(s).add((n==null?void 0:n.replace("d",""))||0,"days").format("YYYY-MM-DD HH:mm:ss"),[s,n]);return e.jsx(a.Typography.Text,{children:u})},B=c.connect(F,c.mapProps({dataSource:"options"}),c.mapReadPretty(V)),{useModal:j}=a.Modal,N=()=>{const n=c.useForm(),{setVisible:s}=t.useActionContext(),{resource:l,service:u}=t.useBlockRequestContext(),{t:x}=b(),[g,A]=j();return{run(){return h(this,null,function*(){var f,P;yield n.submit();const v=yield l.create({values:n.values});g.success({title:x("API key created successfully"),onOk:()=>{n.reset(),s(!1)},content:e.jsxs(a.Space,{direction:"vertical",children:[e.jsx(a.Alert,{message:x("Make sure to copy your personal access key now as you will not be able to see this again."),type:"warning"}),e.jsx(a.Typography.Text,{copyable:!0,children:(P=(f=v.data)==null?void 0:f.data)==null?void 0:P.token})]})}),u==null||u.refresh()})},element:A}},O=()=>{const n=t.useRecord(),{resource:s,service:l}=t.useBlockRequestContext();return{run(){return h(this,null,function*(){yield s.destroy({filterByTk:n.id}),l.refresh()})}}},E={type:"object",properties:{configuration:{type:"void","x-decorator":"TableBlockProvider","x-decorator-props":{collection:"apiKeys",resource:"apiKeys",action:"list",params:{pageSize:20,appends:["role"],sort:["-createdAt"]},rowKey:"name",showIndex:!0},"x-component":"CardItem",properties:{actions:{type:"void","x-component":"ActionBar","x-component-props":{style:{marginBottom:"var(--nb-spacing)"}},properties:{create:{type:"void","x-action":"create",title:r("Add API key"),"x-component":"Action","x-component-props":{openMode:"drawer",type:"primary"},properties:{drawer:{type:"void",title:r("Add API key"),"x-decorator":"Form","x-component":"Action.Modal","x-component-props":{maskClosable:!1,style:{maxWidth:"520px",width:"100%"}},properties:{name:{type:"string",title:r("Key name"),required:!0,"x-component":"CollectionField","x-decorator":"FormItem"},role:{type:"string",title:r("Role"),required:!0,"x-decorator-props":{tooltip:r("Allow only your own roles to be selected")},"x-collection-field":"apiKeys.role","x-component":"CollectionField","x-decorator":"FormItem"},expiresIn:{type:"string",title:r("Expiration"),required:!0,"x-component":"CollectionField","x-decorator":"FormItem",default:"30d"},footer:{type:"void","x-component":"Action.Modal.Footer",properties:{cancel:{title:'{{t("Cancel")}}',"x-component":"Action","x-component-props":{useAction:"{{ cm.useCancelAction }}"}},submit:{title:'{{t("Submit")}}',"x-component":"Action","x-component-props":{type:"primary",useAction:N}}}}}}},"x-align":"right"}}},[m.uid()]:{type:"array","x-component":"TableV2","x-component-props":{rowKey:"id",useProps:"{{ useTableBlockProps }}"},properties:{column1:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Key name"),properties:{name:{type:"string","x-component":"CollectionField","x-read-pretty":!0}}},column2:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Role"),properties:{role:{type:"object","x-collection-field":"apiKeys.role","x-component":"CollectionField","x-component-props":{enableLink:!1},"x-read-pretty":!0}}},column3:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Expiration"),properties:{expiresIn:{type:"string","x-component":"CollectionField","x-read-pretty":!0}}},column4:{type:"void","x-decorator":"TableV2.Column.Decorator","x-component":"TableV2.Column",title:r("Created at"),properties:{createdAt:{type:"date","x-component":"DatePicker","x-component-props":{format:"YYYY-MM-DD HH:mm:ss"},"x-read-pretty":!0}}},actionColumn:{type:"void",title:'{{ t("Actions") }}',"x-action-column":"actions","x-decorator":"TableV2.Column.ActionBar","x-component":"TableV2.Column",properties:{columnActions:{type:"void","x-component":"Space","x-component-props":{split:"|"},properties:{delete:{type:"void",title:'{{ t("Delete") }}',"x-component":"Action.Link","x-component-props":{confirm:{title:r("Delete API key"),content:"{{t('Are you sure you want to delete it?')}}"},useAction:O}}}}}}}}}}}},Y=()=>{const n=t.useCurrentRoles();return e.jsx(t.CollectionManagerProvider,{collections:[M],children:e.jsx(t.SchemaComponentOptions,{scope:{currentRoles:n},components:{ExpiresSelect:B},children:e.jsx(c.RecursionField,{schema:E})})})},T=y.memo(n=>{const{t:s}=b();return e.jsx(t.SettingsCenterProvider,{settings:{"api-keys":{title:s("API keys"),icon:"EnvironmentOutlined",tabs:{configuration:{title:s("Keys manager"),component:Y}}}},children:e.jsx(t.SchemaComponentOptions,{components:{},children:n.children})})});T.displayName="ApiKeysProvider";class H extends t.Plugin{load(){return h(this,null,function*(){this.app.addProvider(T)})}}o.default=H,Object.defineProperties(o,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
@@ -1,13 +1,13 @@
1
1
  module.exports = {
2
- "@nocobase/client": "0.14.0-alpha.7",
2
+ "@nocobase/client": "0.14.0-alpha.8",
3
3
  "react": "18.2.0",
4
- "@nocobase/database": "0.14.0-alpha.7",
5
- "@nocobase/server": "0.14.0-alpha.7",
4
+ "@nocobase/database": "0.14.0-alpha.8",
5
+ "@nocobase/server": "0.14.0-alpha.8",
6
6
  "@formily/react": "2.2.27",
7
7
  "ahooks": "3.7.8",
8
8
  "antd": "5.8.6",
9
9
  "dayjs": "1.11.9",
10
10
  "@formily/shared": "2.2.27",
11
11
  "react-i18next": "11.18.6",
12
- "@nocobase/actions": "0.14.0-alpha.7"
12
+ "@nocobase/actions": "0.14.0-alpha.8"
13
13
  };
@@ -14,6 +14,8 @@ Here's an example using cURL:
14
14
  curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'
15
15
  ```
16
16
 
17
+ > Warning: When using the `Docker` image to use `NocoBase`, make sure you have configured the [APP_KEY](https://docs.nocobase.com/api/env#app_key) environment variable, otherwise the API key will be invalid after each restart.
18
+
17
19
  ## Deleting an API key
18
20
 
19
21
  After deleting the API key, it will no longer be usable.
@@ -14,6 +14,8 @@ cURL 的例子如下
14
14
  curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'
15
15
  ```
16
16
 
17
+ > Warning: 当你使用 `Docker` 镜像来使用 `NocoBase` 时,请确保你配置了 [APP_KEY](https://docs-cn.nocobase.com/api/env#app_key) 环境变量,否则 API key 将在每次重启后失效。
18
+
17
19
  ## 删除 API key
18
20
 
19
21
  删除 API key 后,该 Key 将无法继续使用。
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "displayName.zh-CN": "API 密钥",
5
5
  "description": "Allows users to use API key to access NocoBase HTTP API",
6
6
  "description.zh-CN": "允许用户使用 API 密钥访问 NocoBase HTTP API",
7
- "version": "0.14.0-alpha.7",
7
+ "version": "0.14.0-alpha.8",
8
8
  "license": "AGPL-3.0",
9
9
  "main": "./dist/server/index.js",
10
10
  "devDependencies": {
@@ -27,5 +27,5 @@
27
27
  "@nocobase/test": "0.x",
28
28
  "@nocobase/utils": "0.x"
29
29
  },
30
- "gitHead": "dc958417d27ed0753439bcef192be91a03dfc30f"
30
+ "gitHead": "59c82fef6e34707802b5841f5ec4d9b3b6b68abb"
31
31
  }