@xano/sdk 1.0.13 → 1.0.15
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 +28 -0
- package/README.md +28 -28
- package/dist/.build-fingerprint +1 -1
- package/dist/{agent-file-refresh-DAFGNMQX.js → agent-file-refresh-ZRGNOA6Q.js} +12 -11
- package/dist/{agent-skill-command-6M46ZGOL.js → agent-skill-command-DV26SDA2.js} +51 -50
- package/dist/{answer-shape-CBUQRSXI.js → answer-shape-AVZSKBR6.js} +4 -4
- package/dist/{backend-dir-J2J7JNS6.js → backend-dir-NTMXWE5R.js} +11 -10
- package/dist/{backend-slot-X5AUX2TT.js → backend-slot-DZAUHLTS.js} +3 -3
- package/dist/bin.js +47 -46
- package/dist/{branch-YS2K3VOB.js → branch-IJTBZZFO.js} +8 -8
- package/dist/{branch-commands-BUKVE637.js → branch-commands-4PJEBNRK.js} +26 -25
- package/dist/{chunk-PCHIHVX6.js → chunk-2LF734YB.js} +4 -4
- package/dist/{chunk-ENBGJJJH.js → chunk-3GZMP7II.js} +9 -9
- package/dist/{chunk-R7XZW4SB.js → chunk-3H7R4ISR.js} +2 -2
- package/dist/{chunk-DB7P2SSK.js → chunk-45K2QZBR.js} +3 -3
- package/dist/{chunk-C2SAVXAB.js → chunk-4MX5LMPQ.js} +2 -2
- package/dist/{chunk-IZI3SYXH.js → chunk-5FJ4M4HB.js} +38 -38
- package/dist/{chunk-FBWMKHLO.js → chunk-5SJQAJLF.js} +3 -3
- package/dist/{chunk-E763QI3G.js → chunk-5SKWGCAJ.js} +2 -2
- package/dist/{chunk-JKGRQW6D.js → chunk-5W7S2SCA.js} +4 -4
- package/dist/{chunk-KICERNAP.js → chunk-66ZU2CD5.js} +4 -4
- package/dist/{chunk-F2NFNYCB.js → chunk-6EFXPTHT.js} +3 -3
- package/dist/{chunk-CTUIMNEM.js → chunk-6X73VFCX.js} +2 -2
- package/dist/{chunk-VTMTIBKP.js → chunk-74OPNM2Z.js} +2 -2
- package/dist/{chunk-DZUNF7IH.js → chunk-75QC66XI.js} +2 -2
- package/dist/{chunk-U4BGBU3R.js → chunk-7AKH4QDJ.js} +44 -44
- package/dist/{chunk-CGZSF756.js → chunk-7ZQ73AHJ.js} +28 -28
- package/dist/{chunk-5SMUND4J.js → chunk-A2N2C2WD.js} +6 -6
- package/dist/{chunk-XL7EA62X.js → chunk-AE5CRAKS.js} +5 -5
- package/dist/{chunk-5ONWBQ2C.js → chunk-ASQX477B.js} +7 -7
- package/dist/{chunk-JFPLHK6Y.js → chunk-AXMUYBWQ.js} +2 -2
- package/dist/{chunk-5XDKKE5Y.js → chunk-B6AFJVG4.js} +4 -4
- package/dist/{chunk-4CS4DKQC.js → chunk-BEKEOXNG.js} +2 -2
- package/dist/{chunk-ZSMHS7BU.js → chunk-CJGLAQRD.js} +4 -4
- package/dist/{chunk-M7DIIJPW.js → chunk-DBDTQR23.js} +4 -4
- package/dist/{chunk-RZABQ4YH.js → chunk-DGYXCIBV.js} +4 -4
- package/dist/{chunk-P6HXDOFG.js → chunk-DH6O5NQU.js} +13 -13
- package/dist/{chunk-I2AVVARA.js → chunk-ECQXASG3.js} +2 -2
- package/dist/{chunk-2BHYGUTI.js → chunk-EQXHUWUO.js} +2 -2
- package/dist/{chunk-EGEANMMK.js → chunk-FIERONKM.js} +2 -2
- package/dist/{chunk-A2AOUBJS.js → chunk-FKQX6KU7.js} +3 -2
- package/dist/{chunk-UECNKDDA.js → chunk-FOBVJ2UR.js} +8 -8
- package/dist/{chunk-GRWYO2MS.js → chunk-FXZEZAV2.js} +3 -3
- package/dist/{chunk-H6VVSGKN.js → chunk-G4WRZU5T.js} +7 -7
- package/dist/{chunk-K6BQPFRS.js → chunk-GBSHHNSD.js} +3 -3
- package/dist/{chunk-N3XSXGAL.js → chunk-GCINMMFL.js} +2 -2
- package/dist/{chunk-WZXEQUIM.js → chunk-GDJCWQIK.js} +2 -2
- package/dist/{chunk-ZACMAKZE.js → chunk-GIQIMWTK.js} +14 -14
- package/dist/{chunk-POZ6V4MU.js → chunk-GKQTXUOW.js} +2 -2
- package/dist/{chunk-D4VKPOD4.js → chunk-GRXX2TOJ.js} +13 -112
- package/dist/{chunk-YJK4NPXC.js → chunk-GVHWIDEJ.js} +3 -3
- package/dist/{chunk-UKC65HBQ.js → chunk-HCNIB3EC.js} +4 -4
- package/dist/{chunk-DILYWJVP.js → chunk-HXFLHA5K.js} +2 -2
- package/dist/{chunk-FLDFKG24.js → chunk-IKXXTRMN.js} +4 -4
- package/dist/{chunk-QWWQM4XZ.js → chunk-JAYHFXWH.js} +7 -7
- package/dist/{chunk-6LECAG3Y.js → chunk-JWASCOHO.js} +4 -4
- package/dist/{chunk-DPSR5GRE.js → chunk-K6SWZ6H4.js} +49 -49
- package/dist/{chunk-VA4JK4TW.js → chunk-KMKUH2IO.js} +3 -3
- package/dist/{chunk-UFFIU57H.js → chunk-LSJ3SQEU.js} +4 -4
- package/dist/{chunk-JHQAVWHW.js → chunk-M7O3T7IM.js} +2 -2
- package/dist/{chunk-BXVNRUDB.js → chunk-MGG4CHO4.js} +3 -3
- package/dist/{chunk-7NNLRNXE.js → chunk-MIS6F4HM.js} +4 -4
- package/dist/{chunk-6HTXQAMG.js → chunk-N72XNQNJ.js} +14 -14
- package/dist/{chunk-H7GMGZHI.js → chunk-NDV6CBR7.js} +2 -2
- package/dist/{chunk-6OOZJQJK.js → chunk-NNI5R6V6.js} +68 -68
- package/dist/{chunk-IFXPHVPY.js → chunk-NPYYDTXS.js} +3 -3
- package/dist/{chunk-DYGRTWAI.js → chunk-O44MJTLR.js} +3 -3
- package/dist/{chunk-HDANNK4A.js → chunk-OZWAITII.js} +9 -9
- package/dist/{chunk-ONNSFD73.js → chunk-P7GKTV7N.js} +10 -10
- package/dist/{chunk-373AVIL2.js → chunk-QAEBBTYR.js} +7 -7
- package/dist/{chunk-3ZVSOZZC.js → chunk-QRMKQYCB.js} +2 -2
- package/dist/{chunk-TANWE2ZY.js → chunk-QW7NGUYW.js} +80 -80
- package/dist/{chunk-U4DSFCH5.js → chunk-R3GPRNBT.js} +2 -2
- package/dist/{chunk-SBS2IYTN.js → chunk-RBTZEHXF.js} +3 -3
- package/dist/{chunk-XFQAA2SU.js → chunk-RVAEPPRH.js} +2 -2
- package/dist/{chunk-W5MKVFBQ.js → chunk-RXNMZM6H.js} +5 -5
- package/dist/{chunk-6QJORUHC.js → chunk-RYWNNJK5.js} +2 -2
- package/dist/{chunk-NZ7ML6LG.js → chunk-SH4RY6QX.js} +290 -98
- package/dist/{chunk-ZGNWMGN3.js → chunk-SHHXLI2K.js} +26 -8
- package/dist/{chunk-MLKJUEG3.js → chunk-SL55XKVL.js} +23 -23
- package/dist/{chunk-H5FAYLCR.js → chunk-SPLRKCFV.js} +2 -2
- package/dist/{chunk-XYVPF63S.js → chunk-SXMZNSQ6.js} +8 -8
- package/dist/{chunk-NMHTB346.js → chunk-TT6LN55R.js} +36 -10
- package/dist/{chunk-B5N6EWOM.js → chunk-TXFOQZUQ.js} +3 -3
- package/dist/{chunk-VFRL4G72.js → chunk-UNFQN3TT.js} +3 -3
- package/dist/{chunk-EKS7SAZS.js → chunk-UVHSMANV.js} +53 -61
- package/dist/{chunk-RQHXYL77.js → chunk-V7WCTXEH.js} +5 -7
- package/dist/{chunk-HEMWBHQS.js → chunk-VUWR5YLE.js} +13 -13
- package/dist/{chunk-O6PWEJUV.js → chunk-VXHXSGPU.js} +8 -8
- package/dist/chunk-VYJYDMY6.js +9 -0
- package/dist/{chunk-C4TZP5PQ.js → chunk-WS2X5BB2.js} +5 -5
- package/dist/{chunk-P5JF3U65.js → chunk-WS4BA75E.js} +37 -4
- package/dist/{chunk-HUEFVPYW.js → chunk-WXKSB2N3.js} +3 -3
- package/dist/{chunk-DFCYAEBE.js → chunk-XLP4CNSF.js} +3 -3
- package/dist/{chunk-OCNTMJSY.js → chunk-XPSDDTUZ.js} +3 -3
- package/dist/{chunk-OBRMA2VK.js → chunk-XY4OBD26.js} +3 -3
- package/dist/{chunk-XVOODRNK.js → chunk-Y5XAPLZS.js} +4 -4
- package/dist/{chunk-ZISPEBNM.js → chunk-YCKKL5PD.js} +60 -55
- package/dist/{chunk-XM56DAM7.js → chunk-YR3MNGWZ.js} +8 -8
- package/dist/{chunk-WQZCFVAD.js → chunk-ZC6H2ERE.js} +5 -5
- package/dist/{chunk-UDCKYLBW.js → chunk-ZDVVIJPU.js} +4 -4
- package/dist/{chunk-ENAUSLMP.js → chunk-ZF2CBXT5.js} +3 -3
- package/dist/{chunk-AUYXBKGR.js → chunk-ZOHEHIFS.js} +2 -2
- package/dist/{chunk-3RZ4UJWV.js → chunk-ZPJXWMHK.js} +4 -4
- package/dist/{chunk-A3CT26GX.js → chunk-ZRXDPCMN.js} +2 -2
- package/dist/{chunk-RAGFXELQ.js → chunk-ZYECXDVV.js} +5 -5
- package/dist/cli.js +45 -44
- package/dist/{codegen-command-BAFON45M.js → codegen-command-RDD4GL35.js} +63 -62
- package/dist/codegen.js +2 -2
- package/dist/{commands-IFRAGWGK.js → commands-5ILSWDSV.js} +2 -2
- package/dist/{completion-RTXCODHS.js → completion-UNKBVVDT.js} +2 -2
- package/dist/{config-EHFXNFSP.js → config-NTOASFCA.js} +3 -3
- package/dist/{deploy-command-JW7R3BPW.js → deploy-command-BYAZZF37.js} +52 -51
- package/dist/{deploy-source-ZUPLAL7L.js → deploy-source-QCPZWNJO.js} +27 -26
- package/dist/{dev-env-sync-W7OTV7OD.js → dev-env-sync-6MHK3UHC.js} +46 -45
- package/dist/{display-name-hint-BKPMISQU.js → display-name-hint-MYXCCAOP.js} +10 -10
- package/dist/{env-example-refresh-TS7WBVZQ.js → env-example-refresh-MQWHY7ZS.js} +64 -63
- package/dist/{env-pull-command-5IYXQ2WK.js → env-pull-command-KUIEKBTM.js} +42 -41
- package/dist/{env-target-TQBPLU2S.js → env-target-Y77RLRS5.js} +9 -9
- package/dist/{env-var-command-AKCWYZPB.js → env-var-command-BZWJD75C.js} +37 -36
- package/dist/{ephemeral-CART6DIR.js → ephemeral-VLPRDNEJ.js} +8 -8
- package/dist/{ephemeral-command-SJYH6XRS.js → ephemeral-command-SYKDPALW.js} +43 -42
- package/dist/{ephemeral-state-HPKSKC4Y.js → ephemeral-state-RUOU2GFS.js} +7 -7
- package/dist/{generate-command-FSCFZPOJ.js → generate-command-CSQDQZSW.js} +68 -67
- package/dist/{gitignore-6IJ66XME.js → gitignore-OQGYM7DO.js} +15 -14
- package/dist/{guards-RU4C7TFG.js → guards-JUYBDLZY.js} +6 -6
- package/dist/{impersonate-command-IH4HMSS3.js → impersonate-command-HSFCZBV6.js} +33 -32
- package/dist/{import-RUBCGLCA.js → import-T4ZTOTBT.js} +4 -4
- package/dist/index.d.ts +105 -109
- package/dist/index.js +11 -11
- package/dist/{init-command-STB4YSAK.js → init-command-6Z7QNVDY.js} +50 -51
- package/dist/{init-modules-YIZYPCMM.js → init-modules-BL2SR5RK.js} +7 -7
- package/dist/{init-web-OGKACAOC.js → init-web-DYE2FEXL.js} +2 -2
- package/dist/internal.d.ts +2 -2
- package/dist/internal.js +68 -62
- package/dist/{keep-data-merge-VRKS64JK.js → keep-data-merge-SHF75FC7.js} +24 -24
- package/dist/{lambda-config-reconcile-FXPDH2U5.js → lambda-config-reconcile-VOBVZPWS.js} +3 -3
- package/dist/{landing-record-5EFK7RI6.js → landing-record-7EOLEKH3.js} +17 -16
- package/dist/{live-diff-HARRGFV4.js → live-diff-M2OLXKM6.js} +6 -6
- package/dist/{local-engine-choice-TRTEJVMV.js → local-engine-choice-TOC3UYZZ.js} +30 -29
- package/dist/{local-engine-command-2FK2PE2P.js → local-engine-command-6KSRDZBR.js} +35 -34
- package/dist/{local-engine-deploy-ZZVHBI2X.js → local-engine-deploy-4N4NFZ4T.js} +11 -11
- package/dist/{local-engine-lookup-QFRKO35F.js → local-engine-lookup-AQTUGSBT.js} +2 -2
- package/dist/{local-engine-mcp-bridge-T2EFRRAF.js → local-engine-mcp-bridge-AMYRH4SY.js} +9 -9
- package/dist/{local-engine-mcp-command-FB7EOGG6.js → local-engine-mcp-command-XTP3EATV.js} +41 -48
- package/dist/{local-engine-process-XH35DURU.js → local-engine-process-OD5OSWDG.js} +6 -6
- package/dist/{local-engine-update-check-HAXE7BVG.js → local-engine-update-check-G3YCBXRE.js} +4 -4
- package/dist/{lock-commands-7PBZIRWR.js → lock-commands-437P6BHY.js} +50 -49
- package/dist/{login-command-2O6GRMTH.js → login-command-BNRDAVFV.js} +23 -22
- package/dist/{logout-command-RZXGW3O2.js → logout-command-FCGCHB7Y.js} +13 -12
- package/dist/{loop-QHZD37KX.js → loop-WOAEXMTC.js} +6 -6
- package/dist/{marketplace-command-NCMLGIMS.js → marketplace-command-SUBJZPJV.js} +33 -33
- package/dist/{marketplace-resolve-HPCRNV5O.js → marketplace-resolve-JR4BBJ6K.js} +5 -5
- package/dist/{meta-client-DYYM5F5G.js → meta-client-AYJS3RQ3.js} +10 -10
- package/dist/{module-manifest-EFE6JBZW.js → module-manifest-63I5GRK4.js} +3 -3
- package/dist/node.d.ts +2 -2
- package/dist/node.js +50 -49
- package/dist/{operation-outcome-SHNROAFA.js → operation-outcome-ORQPVJKB.js} +19 -19
- package/dist/{output-target-PSSR3E4N.js → output-target-KNHHNDM3.js} +16 -15
- package/dist/{plan-disclosure-WEMB5ZJ2.js → plan-disclosure-4DUFRGCP.js} +16 -16
- package/dist/{plugin-contributions-U5PAZKBE.js → plugin-contributions-YYEP7IWH.js} +4 -4
- package/dist/{plugin-prompt-O5PAMV5B.js → plugin-prompt-GKCQKNYI.js} +4 -4
- package/dist/{plugin-questions-ZVYNKDRB.js → plugin-questions-P7MA3TYI.js} +3 -3
- package/dist/{preflight-command-6F7JF3YQ.js → preflight-command-32GFVKSN.js} +56 -55
- package/dist/{profile-command-5AOGD6GV.js → profile-command-U2XTKOMF.js} +24 -23
- package/dist/{profile-pointer-VTOZDBHM.js → profile-pointer-JJ7K5O2R.js} +3 -3
- package/dist/{project-dependency-EZNTHMWI.js → project-dependency-X3KCWBK5.js} +6 -6
- package/dist/{project-sdk-ZGJM4WYQ.js → project-sdk-YHJZRCNB.js} +3 -3
- package/dist/promote-command-OO56IZBT.js +148 -0
- package/dist/{prompt-F7UVH4GP.js → prompt-QNMJIWNI.js} +3 -3
- package/dist/{publish-command-6VVSJPLI.js → publish-command-5ZVZ6IYT.js} +55 -54
- package/dist/{pull-command-GE2WUEUF.js → pull-command-LT5PCEIW.js} +66 -65
- package/dist/{pull-superseded-77UZ7CHH.js → pull-superseded-6HADGGC5.js} +3 -3
- package/dist/{release-command-55RTR674.js → release-command-RBUOXIH7.js} +60 -59
- package/dist/{release-ns-command-5XPZ2B6N.js → release-ns-command-LDN5DOKQ.js} +78 -77
- package/dist/{retry-command-S5QALD5Z.js → retry-command-LFZYEVRU.js} +7 -7
- package/dist/{routes-manifest-ET2TTSCL.js → routes-manifest-BMAOL6WN.js} +6 -6
- package/dist/{routes-manifest-file-42FTJHRY.js → routes-manifest-file-MPOVKD6N.js} +9 -9
- package/dist/scaffold.d.ts +0 -5
- package/dist/scaffold.js +2 -2
- package/dist/{secrets-file-N5IF265R.js → secrets-file-7QM3ORGX.js} +15 -14
- package/dist/{secrets-fill-command-35WKBURT.js → secrets-fill-command-OZ537VOD.js} +49 -48
- package/dist/{seed-5YLQRT2D.js → seed-ATGBOEJP.js} +6 -6
- package/dist/{source-resolve-JXGOVJD3.js → source-resolve-QYSWA3QR.js} +17 -17
- package/dist/{static-host-TQP3FXPI.js → static-host-MO4VDHL7.js} +4 -4
- package/dist/{status-command-G3DFRMU7.js → status-command-IEB4K7ME.js} +60 -34
- package/dist/{store-ZE5BXCOW.js → store-AJX4MC7Y.js} +5 -5
- package/dist/{store-BM7SQcUt.d.ts → store-DspGMsFY.d.ts} +112 -118
- package/dist/{sync-baseline-JGAAOS25.js → sync-baseline-IB7MABZO.js} +7 -7
- package/dist/{sync-contributions-7T4CSPVQ.js → sync-contributions-DLV5JZUK.js} +8 -8
- package/dist/{sync-record-ILWS44DG.js → sync-record-NE62ERA3.js} +9 -9
- package/dist/{table-V3LTQUY6.js → table-TFD4ZQXA.js} +8 -8
- package/dist/{tables-command-7NUOZBHX.js → tables-command-IMCVPUFY.js} +35 -34
- package/dist/{tenant-7WUS7Q6V.js → tenant-IIYECNWO.js} +9 -9
- package/dist/{tenant-command-JGEHRKN7.js → tenant-command-77KG76MU.js} +83 -82
- package/dist/{test-command-2LNEA6GK.js → test-command-NSPU4RUO.js} +32 -31
- package/dist/{tests-ENFUACKD.js → tests-JWQRHFCT.js} +5 -5
- package/dist/{token-DWNH44NW.js → token-BDHD7GU3.js} +9 -8
- package/dist/{toolchain-hooks-QIFGPGH2.js → toolchain-hooks-QHJRDCRW.js} +8 -8
- package/dist/{toolchain-modules-F4DUMWTO.js → toolchain-modules-LY7BMYG6.js} +4 -4
- package/dist/{toolchain-peers-K44IINPG.js → toolchain-peers-FQJBTKEB.js} +7 -7
- package/dist/{tracked-backend-ZFXVLBBJ.js → tracked-backend-BIR7YJCE.js} +30 -29
- package/dist/{update-check-KBHT63GJ.js → update-check-JDARCXAX.js} +48 -47
- package/dist/{upgrade-command-CI543AZP.js → upgrade-command-YCADQCIA.js} +51 -50
- package/dist/{whoami-command-77DXENWD.js → whoami-command-IZCTUPM4.js} +12 -11
- package/dist/{workspace-RI5C77BZ.js → workspace-TK52V7WO.js} +4 -4
- package/dist/{workspace-binding-PR57NBGH.js → workspace-binding-3UT6PP4B.js} +11 -10
- package/dist/{workspace-command-6HHVFQKW.js → workspace-command-46OCB6XT.js} +79 -78
- package/dist/{workspace-env-2APJEASO.js → workspace-env-PVPOWFNZ.js} +12 -11
- package/dist/{workspace-export-GHMUSX2P.js → workspace-export-PUEXKZNS.js} +4 -4
- package/dist/{writable-Y6CE2CGK.js → writable-LMMG4AFZ.js} +3 -3
- package/dist/{xano-2A2GT7EH.js → xano-EOUVXNQX.js} +7 -7
- package/dist/{xanosdk-import-HBQH3ZBS.js → xanosdk-import-XXJT365U.js} +5 -5
- package/dist/{xanosdk-project-W45IR3Q7.js → xanosdk-project-CJKRLQ6U.js} +13 -12
- package/guides/README.md +3 -3
- package/guides/authoring.md +11 -11
- package/guides/bundle.md +2 -2
- package/guides/cli.md +179 -176
- package/guides/codegen.md +17 -17
- package/guides/codes.md +3 -3
- package/guides/coverage.md +2 -2
- package/guides/deploying.md +123 -123
- package/guides/environment.md +30 -30
- package/guides/marketplace.md +24 -24
- package/guides/module-contract.md +9 -9
- package/guides/object-kinds.md +4 -4
- package/guides/project-structure.md +4 -4
- package/guides/scaffold.md +22 -22
- package/guides/typed-frontend.md +3 -3
- package/llms/client.md +4 -4
- package/llms/errors.md +2 -2
- package/llms/fields.md +1 -1
- package/llms/kinds-agent-mcp.md +1 -1
- package/llms/kinds-realtime.md +2 -2
- package/llms/lock.md +3 -3
- package/llms/statements-calls.md +1 -1
- package/llms/statements-catalog.md +57 -57
- package/llms/statements-runtime.md +2 -2
- package/llms/tests.md +3 -3
- package/llms/toolchain.md +2 -2
- package/llms-full.txt +113 -110
- package/llms.txt +35 -32
- package/manifest.json +82 -152
- package/package.json +1 -1
- package/skills/xano-backend/SKILL.md +7 -7
- package/dist/promote-command-O2NRRFLK.js +0 -147
package/guides/environment.md
CHANGED
|
@@ -15,15 +15,15 @@ are what you get when the variable is unset.
|
|
|
15
15
|
| `XANO_WORKSPACE_ID` | Numeric workspace the meta credential acts on. |
|
|
16
16
|
| `XANO_META_TOKEN` | Meta API bearer token. With the two above it forms a complete credential that outranks every other source, reads no file, and never rotates. |
|
|
17
17
|
| `XANO_REFRESH_TOKEN` | OAuth refresh token for non-interactive runs (CI, agents). Paired with `XANO_CLIENT_ID`; the target instance comes from the token's own `aud` claim. Rotates on use — prefer the meta credential above. |
|
|
18
|
-
| `XANO_CLIENT_ID` | OAuth client id that goes with `XANO_REFRESH_TOKEN`. Both are copied once out of the profile in `auth.json` after a local `
|
|
18
|
+
| `XANO_CLIENT_ID` | OAuth client id that goes with `XANO_REFRESH_TOKEN`. Both are copied once out of the profile in `auth.json` after a local `npx @xano/sdk login`. |
|
|
19
19
|
| `XANO_CONFIG` | Explicit path to the credential file. Wins over both default locations — the same thing `--config <path>` does. Refused beside `--local-auth`, which names a different file. |
|
|
20
20
|
| `XANO_PROFILE` | Which stored credential profile to act as, when no `--profile` names one. Outranked by the flag, by the project's `xano.profile.json` pin, and by an environment credential (which displaces it with a note on stderr). |
|
|
21
21
|
| `XANO_GLOBAL_CONFIG` | Moves the **shared** credential cache off `~/.xanosdk/auth.json`. Only changes where the global cache lives; the project-local `./.xano/auth.json` and the `XANO_CONFIG`/`--config` override are unaffected. |
|
|
22
22
|
| `XANO_CLIENT_FILE` | Moves the OAuth **client-registration** cache off `~/.xano/xanosdk-clients.json`. That file holds the `client_id` minted per auth host + redirect URI, not a credential. |
|
|
23
23
|
| `XANO_ORIGIN` | OAuth host to sign in against, instead of the default — the same thing `--origin` does. An origin only (`https://host`): a path, query or fragment is refused. |
|
|
24
|
-
| `XANO_NO_BROWSER` | Set to anything non-empty and `
|
|
24
|
+
| `XANO_NO_BROWSER` | Set to anything non-empty and `npx @xano/sdk login` will **not** launch a browser; it prints the authorize URL to stderr for you to open yourself. The loopback server still runs and still waits for the redirect, so the flow completes only if the browser you open it in can reach this machine's `127.0.0.1`. For a machine that has no browser to launch. When the browser is on a **different** machine, that redirect cannot arrive — use `npx @xano/sdk login --paste` instead. |
|
|
25
25
|
|
|
26
|
-
**`
|
|
26
|
+
**`npx @xano/sdk preflight`** — an optional override target. With none of these set, `preflight` uses the stored login credential and creates its ephemeral under the workspace that credential pins
|
|
27
27
|
|
|
28
28
|
| Variable | What it does |
|
|
29
29
|
|---|---|
|
|
@@ -45,7 +45,7 @@ are what you get when the variable is unset.
|
|
|
45
45
|
|---|---|
|
|
46
46
|
| `XANOSDK_NO_UPDATE_CHECK` | Turns the "a newer version is out" notice off (it reads the registry at most once an hour). |
|
|
47
47
|
| `NO_UPDATE_NOTIFIER` | The de-facto convention, honored identically. `CI` being set also silences the notice. |
|
|
48
|
-
| `XANOSDK_INSTALL_MODE` | `global` or `local` — pins whether the notice suggests `npm i -g` or `
|
|
48
|
+
| `XANOSDK_INSTALL_MODE` | `global` or `local` — pins whether the notice suggests `npm i -g` or `npx @xano/sdk upgrade` (a project-local install), instead of detecting it. |
|
|
49
49
|
| `XANOSDK_UPDATE_REGISTRY` | Registry URL the check reads, instead of the npm endpoint for `@xano/sdk`. |
|
|
50
50
|
| `XANOSDK_UPDATE_CACHE` | Moves the check's cache file off `~/.xanosdk/update-check.json`. |
|
|
51
51
|
|
|
@@ -56,13 +56,13 @@ are what you get when the variable is unset.
|
|
|
56
56
|
| `XANOSDK_ENGINE_OVERRIDE` | An engine to run instead of the project's pinned one, for every `deploy --local` in this shell: a version (`v0.1.8`), an `https://` URL to an engine archive (plain `http://` only from this machine), or an archive path. A value on `--local=` beats it; it never reads or moves the pin. |
|
|
57
57
|
| `XANOSDK_ENGINE_TOKEN` | Bearer credential sent with an override URL's download — only to that URL's own origin, never to another host a redirect leads to. |
|
|
58
58
|
| `XANOSDK_ENGINE_HOME` | Moves everything the Xano Engine writes off `~/.xanosdk/local-engine`: the engine cache, the running-engine records, and the engine's own logs and runtime data — see [where the engine keeps its data](deploying.md#where-the-engine-keeps-its-data). |
|
|
59
|
-
| `XANOSDK_ENGINE_RELEASES_URL` | A different engine release service for version lookups. Its engines are fetched fresh each deploy, the pin is not read or written, and `
|
|
59
|
+
| `XANOSDK_ENGINE_RELEASES_URL` | A different engine release service for version lookups. Its engines are fetched fresh each deploy, the pin is not read or written, and `npx @xano/sdk local update` refuses while it is set. |
|
|
60
60
|
|
|
61
61
|
**Escape hatches**
|
|
62
62
|
|
|
63
63
|
| Variable | What it does |
|
|
64
64
|
|---|---|
|
|
65
|
-
| `XANOSDK_MARKETPLACE_URL` | Base URL the `
|
|
65
|
+
| `XANOSDK_MARKETPLACE_URL` | Base URL the `npx @xano/sdk marketplace` reads hit, instead of the published catalogue. Repoints the three read verbs without waiting for a release. A path is kept, so `https://<instance>/tenant/<name>` works. |
|
|
66
66
|
| `XANOSDK_PROVE_DIFF` | A file path. Codegen appends one JSON line per statement that fell back to `raw()` — the arm that declined and the key paths where the re-encode disagreed. The decline *reason* is on the report either way; this adds the machine-readable detail. |
|
|
67
67
|
|
|
68
68
|
> `process.env` read inside a **workspace definition** is a different thing entirely: it
|
|
@@ -95,7 +95,7 @@ checked-out project never holds a secret it did not fetch on purpose.
|
|
|
95
95
|
|
|
96
96
|
| Path | What it is |
|
|
97
97
|
|---|---|
|
|
98
|
-
| `xano/.env` | Where the values live. Gitignored by the scaffold, and preserved across a `
|
|
98
|
+
| `xano/.env` | Where the values live. Gitignored by the scaffold, and preserved across a `npx @xano/sdk pull` rather than rewritten. Read with no flag by the commands that compile a bundle: `deploy`, `export`, `preflight`, and `release create`, whose convergence comparison compiles the entry unless `--bundle` names one. |
|
|
99
99
|
| `xano/.env.example` | Generated beside it, listing the declared names as commented lines. Committed. Copy it to `xano/.env` on a fresh clone and fill in the values. The lines stay commented on purpose, so an unedited copy meets the refusal below rather than sending empty strings to your backend. |
|
|
100
100
|
|
|
101
101
|
`xano/` is the scaffold's backend directory. The file is read from the directory of the
|
|
@@ -107,9 +107,9 @@ it looked for.
|
|
|
107
107
|
**Filling it**
|
|
108
108
|
|
|
109
109
|
```bash
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
110
|
+
npx @xano/sdk env pull # fetch the values from the source this project last deployed to
|
|
111
|
+
npx @xano/sdk env pull --from tenant:prod # name the source explicitly
|
|
112
|
+
npx @xano/sdk env pull --from workspace --yes # and skip the confirmation
|
|
113
113
|
```
|
|
114
114
|
|
|
115
115
|
The source is a backend that is running: `workspace`, `ephemeral[:<name>]`,
|
|
@@ -131,9 +131,9 @@ resolved env values in cleartext (see the `--bundle` note below).
|
|
|
131
131
|
**Changing one value on a running backend**
|
|
132
132
|
|
|
133
133
|
```bash
|
|
134
|
-
printf %s "$STRIPE_KEY" |
|
|
135
|
-
|
|
136
|
-
|
|
134
|
+
printf %s "$STRIPE_KEY" | npx @xano/sdk env set STRIPE_KEY --to workspace --yes # value on stdin
|
|
135
|
+
npx @xano/sdk env set FEATURE_FLAG on --to local # or as the second argument
|
|
136
|
+
npx @xano/sdk env unset STRIPE_KEY --to tenant:prod-eu # remove it
|
|
137
137
|
```
|
|
138
138
|
|
|
139
139
|
`env set` creates the variable or replaces its value, and `env unset` removes it. Every other
|
|
@@ -179,7 +179,7 @@ and is not refused — unless `--keep-data` cannot keep that environment's data
|
|
|
179
179
|
replaces it after all. A `deploy --to` without `--replace` merges the same add-only way, and it
|
|
180
180
|
still refuses: a name the target does not hold would be created there with no value, on a
|
|
181
181
|
backend someone keeps. A `--dry-run` sends nothing, so it reports the refusal the real deploy
|
|
182
|
-
would make as a warning and prints its plan. `
|
|
182
|
+
would make as a warning and prints its plan. `npx @xano/sdk env pull` warns about each declared name
|
|
183
183
|
the backend holds no value for, since the file it writes has none for it either.
|
|
184
184
|
|
|
185
185
|
**The refusal only covers declared names.** A variable that exists in the backend but is not
|
|
@@ -189,7 +189,7 @@ routes reach that state: someone adds a variable in the backend after your last
|
|
|
189
189
|
swapping `xano/.env` for an `--backend-env-file` that holds only the declared names. So declare every
|
|
190
190
|
name the stack reads, and carry the rest across when you swap files.
|
|
191
191
|
|
|
192
|
-
The refusal is part of the **compile**, so `
|
|
192
|
+
The refusal is part of the **compile**, so `npx @xano/sdk deploy --bundle <path>` does not get it. A
|
|
193
193
|
pre-built bundle carries whatever env it was built with and sends exactly that, so a
|
|
194
194
|
build-once-deploy-the-artifact pipeline resolves its values at build time: pass
|
|
195
195
|
`--backend-env-file`/`--env-var` to the `export` that produces the bundle. Two consequences worth
|
|
@@ -213,18 +213,18 @@ identity, and a dotenv file is the right shape. A documentation token is address
|
|
|
213
213
|
**object** that holds it: this workspace, that API group. It has no name of its own, so it is
|
|
214
214
|
stored under that object's identity instead, and `env(...)` cannot read it from anywhere.
|
|
215
215
|
|
|
216
|
-
That file is SDK-owned. `
|
|
216
|
+
That file is SDK-owned. `npx @xano/sdk pull` writes it and every build reads it back, so a pull
|
|
217
217
|
followed by a deploy restores the gate with no manual step — which is the whole reason it
|
|
218
218
|
exists. Nobody edits it by hand; `--no-secrets` on a pull finds the tokens and writes none, for
|
|
219
219
|
a machine where a secret on disk is not wanted.
|
|
220
220
|
|
|
221
221
|
A pull only answers for an object that already HAS a token. A gate you declare in source — a new
|
|
222
222
|
API group, or a doc site you decided to close — has none to fetch, and that is what
|
|
223
|
-
`
|
|
223
|
+
`npx @xano/sdk secrets fill` is for:
|
|
224
224
|
|
|
225
225
|
```bash
|
|
226
|
-
|
|
227
|
-
|
|
226
|
+
npx @xano/sdk secrets fill # every declared gate with no value gets one
|
|
227
|
+
npx @xano/sdk secrets fill ./xano/index.ts # name the entry when you are not in the project root
|
|
228
228
|
```
|
|
229
229
|
|
|
230
230
|
It mints a cryptographically random token per gate, the same shape a platform-minted one has,
|
|
@@ -260,7 +260,7 @@ cleared one.
|
|
|
260
260
|
One thing to clear out by hand if you used an earlier build: a `XANO_DOCS_TOKEN…` line left in
|
|
261
261
|
`xano/.env` from when tokens lived there is now an ordinary **backend** variable, because that file
|
|
262
262
|
is backend-only again. It will be sent as part of the workspace's env, where `env("NAME")` reads it
|
|
263
|
-
from every request. Delete the line — the value belongs in `xano/.secrets.json`, and `
|
|
263
|
+
from every request. Delete the line — the value belongs in `xano/.secrets.json`, and `npx @xano/sdk pull`
|
|
264
264
|
puts it there.
|
|
265
265
|
|
|
266
266
|
An entry the file holds that no scope in your source claims is **reported and never deleted** —
|
|
@@ -289,7 +289,7 @@ plus the `canonical` URL tokens of API groups and toolsets (which the engine oth
|
|
|
289
289
|
randomizes, giving the same code different public URLs per environment). Every command that
|
|
290
290
|
compiles an entry file writes it — `export`, `deploy`, `preflight`, with no flag —
|
|
291
291
|
and updates it on every build, atomically, before the bundle. **Commit it next to your code.**
|
|
292
|
-
`npm run xano:check` is the CI guard (the `routes --strict` freshness check, then the project typecheck, then `
|
|
292
|
+
`npm run xano:check` is the CI guard (the `routes --strict` freshness check, then the project typecheck, then `npx @xano/sdk export ./xano/index.ts --check --strict`, which implies
|
|
293
293
|
`--frozen-lock`, writes nothing, and needs neither `xano/.env` nor `xano/.secrets.json`): it fails rather than change the lock,
|
|
294
294
|
so an uncommitted identity change is caught in review instead of on a deploy. It also fails
|
|
295
295
|
while the lock carries an entry no exported object matches. That entry is how a rename looks
|
|
@@ -316,7 +316,7 @@ delete-and-recreate of every object, reported as success. If the lock itself is
|
|
|
316
316
|
**Releasing to a workspace that already exists?** Adopt what it already serves *first*:
|
|
317
317
|
|
|
318
318
|
```bash
|
|
319
|
-
|
|
319
|
+
npx @xano/sdk lock import <its-packageExport.json> --lock=xano/xano.lock
|
|
320
320
|
```
|
|
321
321
|
|
|
322
322
|
Without that step your first locked build mints its own URL token for every API group that
|
|
@@ -358,9 +358,9 @@ export warns about the orphaned entry and names the fix-up:
|
|
|
358
358
|
|
|
359
359
|
```bash
|
|
360
360
|
# code: defineFunction({ name: "signup" }) → { name: "register" }
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
361
|
+
npx @xano/sdk export ./xano/index.ts # stderr: lock entry "function:signup" matches no exported object…
|
|
362
|
+
npx @xano/sdk lock rename --entry=xano/index.ts function signup register
|
|
363
|
+
npx @xano/sdk export ./xano/index.ts # emits signup's original guid under "register" → engine renames in place
|
|
364
364
|
```
|
|
365
365
|
|
|
366
366
|
**Merge conflicts** — two branches that both touched the lock can conflict in git, and a
|
|
@@ -371,8 +371,8 @@ delete the markers. If both branches renamed the same object — one to `stock`,
|
|
|
371
371
|
Keep the name your code exports and drop the other; both commands read such a lock:
|
|
372
372
|
|
|
373
373
|
```bash
|
|
374
|
-
|
|
375
|
-
|
|
374
|
+
npx @xano/sdk lock rename --entry=xano/index.ts table stock goods # moves stock's identity onto goods
|
|
375
|
+
npx @xano/sdk lock prune --identity-only --yes table:stock --lock=xano/xano.lock # or just drop it
|
|
376
376
|
```
|
|
377
377
|
|
|
378
378
|
`rename`/`import` take no entry file, so on their own they look for `xano.lock` in the
|
|
@@ -383,17 +383,17 @@ stop, rather than writing a file you did not name.
|
|
|
383
383
|
|
|
384
384
|
**After `--replace`** — a replace rebuilds the workspace with fresh engine identities, so the
|
|
385
385
|
lock is stale the moment it finishes and the next ordinary merge would match nothing and
|
|
386
|
-
try to create everything. `
|
|
386
|
+
try to create everything. `npx @xano/sdk deploy ./xano/index.ts --to workspace --replace` now re-pins the lock from the rebuilt
|
|
387
387
|
workspace itself and tells you to commit it. If there is no lock to re-pin, it says so —
|
|
388
388
|
without one, the next merge duplicates every object.
|
|
389
389
|
|
|
390
|
-
**Importing a live workspace's identities** — `
|
|
390
|
+
**Importing a live workspace's identities** — `npx @xano/sdk lock import <bundle.json>` seeds the lock from a
|
|
391
391
|
real engine `packageExport`, capturing the live workspace's random guids by `(type, name)`
|
|
392
392
|
so code takes over an existing workspace and the first sync updates in place instead of
|
|
393
393
|
duplicating.
|
|
394
394
|
|
|
395
395
|
**CI** — the scaffolded `npm run xano:check` runs the `routes --strict` freshness check, the project typecheck, and
|
|
396
|
-
`
|
|
396
|
+
`npx @xano/sdk export ./xano/index.ts --check --strict`, which runs every check an export runs and writes nothing, so it needs no secrets. It implies `--frozen-lock`, which
|
|
397
397
|
fails instead of changing the lock, so a canonical
|
|
398
398
|
minted in a throwaway container can never silently diverge public URLs. Mint locally, commit
|
|
399
399
|
the lock. It fails on an entry no exported object matches too, which is the state a rename
|
package/guides/marketplace.md
CHANGED
|
@@ -7,14 +7,14 @@ An **add-on** is an ordinary npm package that declares itself to Xano SDK in its
|
|
|
7
7
|
marketplace` verbs that find one and change what your project has installed.
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
10
|
+
npx @xano/sdk marketplace list # every published add-on, newest first
|
|
11
|
+
npx @xano/sdk marketplace search auth # narrow by keyword
|
|
12
|
+
npx @xano/sdk marketplace details @xano-sdk/auth # what it installs, and how to register it
|
|
13
|
+
npx @xano/sdk marketplace details @xano-sdk/auth --prompt # ...as instructions for a coding agent
|
|
14
|
+
|
|
15
|
+
npx @xano/sdk marketplace install @xano-sdk/auth # add it to the project you are in
|
|
16
|
+
npx @xano/sdk marketplace reinstall <toolchain-package> # re-ask a toolchain module its questions
|
|
17
|
+
npx @xano/sdk marketplace remove <toolchain-package> # uninstall it and drop what it contributed
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
The split is deliberate. The three read verbs hit a public catalogue: no token, no
|
|
@@ -52,7 +52,7 @@ is compiled or a workspace is checked.
|
|
|
52
52
|
Add to xano/index.ts:
|
|
53
53
|
import { registerAuth } from "@xano-sdk/auth";
|
|
54
54
|
registerAuth(app, { canonical: "authn" });
|
|
55
|
-
Then run `npx
|
|
55
|
+
Then run `npx @xano/sdk export ./xano/index.ts --out /dev/null && npm run xano:routes` to bring xano.lock and the route manifest up to date.
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
```
|
|
@@ -75,7 +75,7 @@ Both print a formatted summary to a terminal and stable JSON to a pipe. There is
|
|
|
75
75
|
discover: an agent gets the machine shape by doing what an agent already does.
|
|
76
76
|
|
|
77
77
|
```bash
|
|
78
|
-
|
|
78
|
+
npx @xano/sdk marketplace search auth | jq -r '.modules[].npm_package'
|
|
79
79
|
```
|
|
80
80
|
|
|
81
81
|
Each JSON row is the whole record `details` returns — `description`, `includes`,
|
|
@@ -115,8 +115,8 @@ The rendering has a fixed shape, filled from the module's own catalogue record:
|
|
|
115
115
|
Register it
|
|
116
116
|
<the xano/index.ts snippet, verbatim>
|
|
117
117
|
|
|
118
|
-
|
|
119
|
-
|
|
118
|
+
npx @xano/sdk marketplace install @scope/name
|
|
119
|
+
npx @xano/sdk marketplace details @scope/name --prompt to hand the wiring to a coding agent
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
The `Installs` rows carry one of `table`, `endpoint`, `function`, `task`, `trigger`, `agent`,
|
|
@@ -146,22 +146,22 @@ tenant (`https://<instance>/tenant/<name>`) can stand in for it. See
|
|
|
146
146
|
## Installing
|
|
147
147
|
|
|
148
148
|
```bash
|
|
149
|
-
|
|
149
|
+
npx @xano/sdk marketplace install @xano-sdk/auth
|
|
150
150
|
```
|
|
151
151
|
|
|
152
152
|
The argument is resolved through the marketplace the way `details` resolves it, before npm
|
|
153
|
-
runs: a module's npm name or its slug (`
|
|
153
|
+
runs: a module's npm name or its slug (`npx @xano/sdk marketplace install auth` installs
|
|
154
154
|
`@xano-sdk/auth`), keeping any version or tag (`auth@next`). The install is then
|
|
155
155
|
`npm install` of that module's package. A name the marketplace does not list is refused
|
|
156
156
|
before npm runs, whatever its scope, with the not-found **exit 8** `details` uses
|
|
157
|
-
(`
|
|
157
|
+
(`npx @xano/sdk marketplace search <name>` finds the real one) — `install` adds marketplace modules,
|
|
158
158
|
not arbitrary npm packages. When the catalogue cannot be
|
|
159
159
|
reached, an `@xano-sdk/` name still installs as typed and any other name is refused. `file:`
|
|
160
160
|
paths, tarball URLs and git specs are installed as given, without a lookup.
|
|
161
161
|
|
|
162
162
|
What the command adds over typing `npm install` yourself is three things npm will not do:
|
|
163
163
|
|
|
164
|
-
1. **Add-ons are on the CLI's map.** `
|
|
164
|
+
1. **Add-ons are on the CLI's map.** `npx @xano/sdk --help` says they exist.
|
|
165
165
|
2. **It refuses before npm runs when you are not in a project.** This is the oldest reason
|
|
166
166
|
the command exists: run `npm install` from a parent directory and npm cheerfully creates
|
|
167
167
|
or mutates the wrong `package.json` and tells you it succeeded.
|
|
@@ -195,10 +195,10 @@ what happened to the file:
|
|
|
195
195
|
scaffolded with its add-ons already installed and registered:
|
|
196
196
|
|
|
197
197
|
```bash
|
|
198
|
-
|
|
198
|
+
npx @xano/sdk init my-app --marketplace @xano-sdk/auth,@xano-sdk/vector
|
|
199
199
|
```
|
|
200
200
|
|
|
201
|
-
`reinstall` and `remove` take those names too: `
|
|
201
|
+
`reinstall` and `remove` take those names too: `npx @xano/sdk marketplace remove auth` removes the
|
|
202
202
|
`@xano-sdk/auth` that `install auth` added. A name the project already depends on is taken as
|
|
203
203
|
typed, with no catalogue lookup, so both keep working offline. A name that is neither in the
|
|
204
204
|
project nor in the catalogue exits 8, as `install` does. `remove` is idempotent: removing a
|
|
@@ -257,12 +257,12 @@ only memory a module has.
|
|
|
257
257
|
no settings: the next `deploy` fires its hooks with an empty config and it runs on its own
|
|
258
258
|
fallbacks with nothing you chose. `export` and `deploy` report that state on every run,
|
|
259
259
|
because the likeliest way a module reaches it is a plain `npm install` or a merged PR,
|
|
260
|
-
neither of which runs
|
|
260
|
+
neither of which runs an SDK command:
|
|
261
261
|
|
|
262
262
|
```
|
|
263
263
|
! A toolchain module is installed but never configured, so it runs on its own
|
|
264
264
|
defaults with nothing this project chose.
|
|
265
|
-
@xano-sdk/xanoscript — configure it with `
|
|
265
|
+
@xano-sdk/xanoscript — configure it with `npx @xano/sdk marketplace install @xano-sdk/xanoscript`
|
|
266
266
|
```
|
|
267
267
|
|
|
268
268
|
Running `install` on a package that is already installed reads as a no-op until you know it
|
|
@@ -293,7 +293,7 @@ Each question a module declares derives a long flag that answers it, so a non-in
|
|
|
293
293
|
does not have to accept defaults:
|
|
294
294
|
|
|
295
295
|
```bash
|
|
296
|
-
|
|
296
|
+
npx @xano/sdk marketplace install @xano-sdk/xanoscript --xanoscript --xanoscript-dir=generated
|
|
297
297
|
```
|
|
298
298
|
|
|
299
299
|
A `string` or `choice` question takes `--flag=value`, not `--flag value`. The CLI cannot know
|
|
@@ -319,7 +319,7 @@ setting on the next run.
|
|
|
319
319
|
## Re-asking: reinstall
|
|
320
320
|
|
|
321
321
|
```bash
|
|
322
|
-
|
|
322
|
+
npx @xano/sdk marketplace reinstall @xano-sdk/xanoscript
|
|
323
323
|
```
|
|
324
324
|
|
|
325
325
|
`reinstall` re-runs npm, then re-asks one module its questions and reconciles, offering your
|
|
@@ -352,7 +352,7 @@ every prompt and finding your chosen directory reverted.
|
|
|
352
352
|
## Removing
|
|
353
353
|
|
|
354
354
|
```bash
|
|
355
|
-
|
|
355
|
+
npx @xano/sdk marketplace remove @xano-sdk/xanoscript
|
|
356
356
|
```
|
|
357
357
|
|
|
358
358
|
`remove` uninstalls the package and then drops the settings and the contributed lines
|
|
@@ -432,7 +432,7 @@ than a warning, and so is a hook that throws.
|
|
|
432
432
|
On a normal run both are reported and skipped, matching every other optional side effect in
|
|
433
433
|
the CLI. The asymmetry exists because if a plugin fails to resolve in CI (a partial install, a
|
|
434
434
|
stale plugin path after a version bump) then its hook never fires, nothing checks what it
|
|
435
|
-
checks, and `
|
|
435
|
+
checks, and `npx @xano/sdk export ./xano/index.ts --frozen-lock` exits 0 against a tree that is wrong. A red guard
|
|
436
436
|
gets fixed; a green one gets trusted.
|
|
437
437
|
|
|
438
438
|
A module's own check therefore rides on the same `--frozen-lock` run as `xano.lock`, so a
|
|
@@ -27,7 +27,7 @@ and defaulting the other way would strand them. A `kind` the SDK does not recogn
|
|
|
27
27
|
defaulted to one kind or the other: the failure a default would produce is a module reported
|
|
28
28
|
as unwired when its only fault is a typo in one string.
|
|
29
29
|
|
|
30
|
-
What that costs you depends on where the typo is read. `
|
|
30
|
+
What that costs you depends on where the typo is read. `npx @xano/sdk init` refuses by name, with
|
|
31
31
|
the valid kinds listed, because a scaffold that silently drops your module is worse than one
|
|
32
32
|
that stops. Every other path, the marketplace verbs and the CLI's own module loading
|
|
33
33
|
included, warns and reads the package as an ordinary dependency rather than taking a whole
|
|
@@ -76,7 +76,7 @@ register function being read. Declare `"options": {}` and the call is written ba
|
|
|
76
76
|
**Omit the key and your module has said nothing either way**, so the SDK imports your entry
|
|
77
77
|
and measures `register`'s arity. A function that takes a second parameter nobody declared is
|
|
78
78
|
left **out** of the generated `xano/index.ts` rather than called without it, with a commented
|
|
79
|
-
call and a pointer to `
|
|
79
|
+
call and a pointer to `npx @xano/sdk marketplace details <pkg> --prompt`. The call would not compile,
|
|
80
80
|
and a fresh scaffold that passes `npm run typecheck` is worth more than one that has your
|
|
81
81
|
module in it.
|
|
82
82
|
|
|
@@ -221,7 +221,7 @@ questions: [
|
|
|
221
221
|
Two reasons the callback form does not exist, and both are hard. A callback would let a
|
|
222
222
|
module hang a command on a TTY read in CI, where there is no one to answer it, and the SDK
|
|
223
223
|
could not even impose a timeout because it cannot tell a slow prompt from a slow computation.
|
|
224
|
-
And `
|
|
224
|
+
And `npx @xano/sdk init --web` renders the questionnaire as a browser form, which can display a list
|
|
225
225
|
of choices but cannot run your callback at all. Declaring the question as data means the SDK
|
|
226
226
|
owns every way of answering it.
|
|
227
227
|
|
|
@@ -284,7 +284,7 @@ which command is running and no access to the filesystem, and it may be called s
|
|
|
284
284
|
in one run and must return the same thing for the same answers.
|
|
285
285
|
|
|
286
286
|
That is what makes the reconcile idempotent. A module is configured whenever its project is
|
|
287
|
-
reconciled, and `
|
|
287
|
+
reconciled, and `npx @xano/sdk init` is only the first of those moments: installing into a project
|
|
288
288
|
that already exists, re-answering later, and removing all run the same pass. The correct
|
|
289
289
|
state is a function of the project's dependencies and its stored answers, so it can be
|
|
290
290
|
rebuilt from scratch at any moment, however your module arrived.
|
|
@@ -431,7 +431,7 @@ onPreflight: async (ctx) => {
|
|
|
431
431
|
},
|
|
432
432
|
```
|
|
433
433
|
|
|
434
|
-
Fires on `
|
|
434
|
+
Fires on `npx @xano/sdk preflight`, contributing a comparison to the report.
|
|
435
435
|
|
|
436
436
|
| `PreflightContext` | What it carries |
|
|
437
437
|
|---|---|
|
|
@@ -472,7 +472,7 @@ const plugin: ToolchainPlugin = {
|
|
|
472
472
|
```
|
|
473
473
|
|
|
474
474
|
Your module's section of the route manifest, `xano/routes.gen.ts`. It runs wherever that file
|
|
475
|
-
is written: `
|
|
475
|
+
is written: `npx @xano/sdk routes ./xano/index.ts --emit xano/routes.gen.ts` (the scaffold's
|
|
476
476
|
`xano:routes`), `init --marketplace` when it writes the project's first manifest, `pull`,
|
|
477
477
|
`generate`, and the refresh `marketplace install`, `reinstall` and `remove` make, so your
|
|
478
478
|
block lands with your module. Not `init --from`: a project it creates has no module installed
|
|
@@ -517,7 +517,7 @@ the file free of the SDK runtime in a frontend bundle. Declare yours in `imports
|
|
|
517
517
|
subpaths, a relative or absolute path, and a protocol (`node:`) are all refused, naming your
|
|
518
518
|
module. Each name must be a plain identifier, with no `as` rename. A package you import must
|
|
519
519
|
resolve from the user's project, so declare it in your `peerDependencies`:
|
|
520
|
-
`
|
|
520
|
+
`npx @xano/sdk marketplace install` adds each peer other than `@xano/sdk` that the project does not
|
|
521
521
|
already declare as a direct dependency, with your range, through the project's package manager.
|
|
522
522
|
|
|
523
523
|
**Synchronous and pure.** No filesystem, network, clock or randomness: the same context must
|
|
@@ -569,7 +569,7 @@ and refuses it by name, with the upgrade to make.
|
|
|
569
569
|
| Shape | Why it is refused | The fix |
|
|
570
570
|
|---|---|---|
|
|
571
571
|
| A `files` hook and no `contributes` | `files` was renamed once the hook stopped running only at scaffold time. | Rename it. `contributes(answers)` returns a `ProjectContributions`. |
|
|
572
|
-
| A `ciSteps` entry in what `contributes` returns | The slot is gone. Your check already rides on `
|
|
572
|
+
| A `ciSteps` entry in what `contributes` returns | The slot is gone. Your check already rides on `npx @xano/sdk export ./xano/index.ts --frozen-lock` through `onBundle` with `frozen` set. | Drop it. No workflow step of your own is needed. |
|
|
573
573
|
| `contributes` returning a string, a number, an array or a Promise | Indistinguishable from "contributed nothing", which is recorded as switched off. | Return an object, or nothing at all. `contributes` is synchronous. |
|
|
574
574
|
| A default export whose `kind` is not `"toolchain"` | The manifest and the module disagree, so one of the two is stale. | Make them agree. |
|
|
575
575
|
| An SDK outside your declared `peerDependencies["@xano/sdk"]` range | Your hooks were written against shapes this SDK does not have, so it would apply nothing. | Upgrade the SDK, or install a build of your module made for it. |
|
|
@@ -628,7 +628,7 @@ Things worth proving about your own module:
|
|
|
628
628
|
|
|
629
629
|
## Publishing
|
|
630
630
|
|
|
631
|
-
Publish to npm like any package. To appear in `
|
|
631
|
+
Publish to npm like any package. To appear in `npx @xano/sdk marketplace list` and `search`, the
|
|
632
632
|
module also needs a catalogue entry, which carries its title, tagline, description, tags, the
|
|
633
633
|
objects it installs, what the user supplies, the registration snippet, and the agent prompt
|
|
634
634
|
`details --prompt` emits. Write that prompt for a machine: it is what `init --marketplace`
|
package/guides/object-kinds.md
CHANGED
|
@@ -133,7 +133,7 @@ query({
|
|
|
133
133
|
|
|
134
134
|
A pull brings tests back, along with a query's saved request/response `example`. The one
|
|
135
135
|
thing it withholds is a test's auth `token` — that is an expiring credential rather than
|
|
136
|
-
authored configuration, so `
|
|
136
|
+
authored configuration, so `npx @xano/sdk init --from` reports it as a deliberate omission instead of
|
|
137
137
|
writing it into a committed tree.
|
|
138
138
|
|
|
139
139
|
**Four of the `Run …` statements only run inside a workflow test.** `s.api.call`,
|
|
@@ -142,7 +142,7 @@ run time, and outside a `workflowTest` stack it cannot reach the target — so o
|
|
|
142
142
|
a query, function or task type-checks, exports, imports and **deploys clean**, then answers
|
|
143
143
|
the first real request
|
|
144
144
|
with `ERROR_FATAL: <Type> does not exist`. It is not per host kind: the same call fails
|
|
145
|
-
identically from a function that a query runs. `
|
|
145
|
+
identically from a function that a query runs. `npx @xano/sdk export` refuses them outside a
|
|
146
146
|
workflow test. `s.function.call`, `s.tool.call`, `s.middleware.call` and `s.addon.call` run
|
|
147
147
|
from any stack, as does `s.function.run` — the ordinary way to invoke a function. To share
|
|
148
148
|
logic between two endpoints, put it in a `defineFunction` and `s.function.run` it from both.
|
|
@@ -351,10 +351,10 @@ a microservice fixes every call site at once. A plain `"name:port"` string is al
|
|
|
351
351
|
and is the only way to reach an instance-level microservice, which isn't a workspace object;
|
|
352
352
|
nothing checks that spelling, so prefer the def wherever there is one.
|
|
353
353
|
|
|
354
|
-
A container takes time to come up, so `
|
|
354
|
+
A container takes time to come up, so `npx @xano/sdk deploy` waits for it: after the import it
|
|
355
355
|
reads each microservice and reports whether it is ready, still starting, or failed, then
|
|
356
356
|
lists them. Skip the wait with `--skip-liveness`. The same report is available any time from
|
|
357
|
-
`
|
|
357
|
+
`npx @xano/sdk status`, `npx @xano/sdk ephemeral get <name>`, and `npx @xano/sdk workspace details`.
|
|
358
358
|
|
|
359
359
|
Two outcomes, and only one of them is a warning:
|
|
360
360
|
|
|
@@ -31,7 +31,7 @@ Paths are lower case throughout — an HTTP verb is the one exception, because i
|
|
|
31
31
|
the method rather than a word. Bindings keep the object's own casing, so a file name
|
|
32
32
|
and the symbol it exports can differ.
|
|
33
33
|
|
|
34
|
-
That is the shape `
|
|
34
|
+
That is the shape `npx @xano/sdk init --from` writes, and its `index.ts` re-exports every object
|
|
35
35
|
by name — import from the tree's root rather than from a file, since a file path moves
|
|
36
36
|
when an object's parent or its `_shared.ts` placement changes. Hand-authored projects are
|
|
37
37
|
free to use any other layout; only `index.ts` registering the objects matters.
|
|
@@ -40,15 +40,15 @@ free to use any other layout; only `index.ts` registering the objects matters.
|
|
|
40
40
|
`new Xano().registerWorkspace({ name: "my-app" })`, returning the same chainable registry.
|
|
41
41
|
Authoring is **declarative def-objects** passed to factories; there is no callback/chaining
|
|
42
42
|
builder. `xano.export()` returns the importable `packageExport` bundle, and
|
|
43
|
-
`
|
|
43
|
+
`npx @xano/sdk export`/`deploy` read the module's default export.
|
|
44
44
|
|
|
45
45
|
## Wiring a project by hand
|
|
46
46
|
|
|
47
|
-
`
|
|
47
|
+
`npx @xano/sdk init` writes all of this for you. Without it, two lines set a project up:
|
|
48
48
|
|
|
49
49
|
```bash
|
|
50
50
|
npm init -y && npm pkg set type=module && npm install -D @xano/sdk
|
|
51
|
-
npx
|
|
51
|
+
npx @xano/sdk upgrade # rewrites npm's caret to the range init writes
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
Write your workspace in `xano/index.ts`; `login` and `deploy` are unchanged. `type=module`
|
package/guides/scaffold.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The scaffolded project
|
|
2
2
|
|
|
3
|
-
What `
|
|
3
|
+
What `npx @xano/sdk init` writes, the two frontend presets, a project with no frontend, adding the backend to an existing app, theming, add-ons, and the SvelteKit prerendering rules.
|
|
4
4
|
|
|
5
5
|
## init flags and add-ons
|
|
6
6
|
|
|
@@ -34,10 +34,10 @@ A scaffold ships `@xano/sdk` and nothing else from the `@xano-sdk` scope. Add-on
|
|
|
34
34
|
install on demand:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
37
|
+
npx @xano/sdk marketplace list # every published add-on
|
|
38
|
+
npx @xano/sdk marketplace search auth # …or narrow by keyword
|
|
39
|
+
npx @xano/sdk marketplace details @xano-sdk/auth # what it installs + how to register it
|
|
40
|
+
npx @xano/sdk marketplace install @xano-sdk/auth # add it to the project you're in
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
The three read verbs hit a public catalogue, so they work before you log in.
|
|
@@ -49,7 +49,7 @@ verbs, what each one does to a project, and how an add-on is configured.
|
|
|
49
49
|
add-ons already wired:
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
|
-
|
|
52
|
+
npx @xano/sdk init my-app --framework react --marketplace @xano-sdk/auth,@xano-sdk/vector
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
That installs each package **and** writes its registration into `xano/index.ts`.
|
|
@@ -67,7 +67,7 @@ have the value. A scaffold that compiles with an add-on switched off beats one
|
|
|
67
67
|
that does not compile at all.
|
|
68
68
|
|
|
69
69
|
Each `--marketplace` name is resolved through the marketplace first, exactly as
|
|
70
|
-
`
|
|
70
|
+
`npx @xano/sdk marketplace install` resolves it: a module's package or its slug
|
|
71
71
|
(`--marketplace auth` installs `@xano-sdk/auth`, never npm's unrelated `auth`). A
|
|
72
72
|
name the marketplace does not list stops `init` with **exit 8** before it writes
|
|
73
73
|
anything. So does a package name the npm registry does not have — the same rule
|
|
@@ -188,11 +188,11 @@ The workflow installs with the project's package manager (npm, pnpm, yarn or bun
|
|
|
188
188
|
and pull request. In a monorepo workspace member it installs at the workspace root and checks
|
|
189
189
|
in the member's directory; move the file to the repository root's `.github/workflows/`, the
|
|
190
190
|
only place GitHub reads it. That script runs three steps in order:
|
|
191
|
-
`
|
|
191
|
+
`npx @xano/sdk routes ./xano/index.ts --emit xano/routes.gen.ts --strict`, which fails when the
|
|
192
192
|
committed route manifest the frontend takes its paths from is stale or missing; the project's
|
|
193
193
|
typecheck (`tsc` on React, `svelte-kit sync && svelte-check` on Svelte, `tsc -p xano` with no
|
|
194
194
|
frontend, each followed by `tsc -p xano/lambdas`); and
|
|
195
|
-
`
|
|
195
|
+
`npx @xano/sdk export ./xano/index.ts --check --strict`: every check an export runs (a build warning fails it), under
|
|
196
196
|
`--frozen-lock`, writing nothing — no bundle, no lock. Because nothing is written, it
|
|
197
197
|
reads no `xano/.env` or `xano/.secrets.json`, so the workflow needs no repository
|
|
198
198
|
secrets, even for an API group whose docs are token-gated. It fails instead of
|
|
@@ -227,17 +227,17 @@ project's `package.json` under `"xanosdk"`, keyed by package name, so a choice m
|
|
|
227
227
|
once survives to every later run.
|
|
228
228
|
|
|
229
229
|
Those questions are asked wherever the project is reconciled — at `init`, and in a
|
|
230
|
-
project that already exists. **`
|
|
230
|
+
project that already exists. **`npx @xano/sdk marketplace install <package>` is not just
|
|
231
231
|
`npm install`:** it runs the module's questionnaire and writes both its settings and
|
|
232
232
|
the `.gitattributes` lines it contributes. A module that arrived any other way — a
|
|
233
233
|
plain `npm install`, a merged pull request, a `git pull` that changed
|
|
234
|
-
`package.json` — is configured by running `
|
|
234
|
+
`package.json` — is configured by running `npx @xano/sdk marketplace install` on it; until
|
|
235
235
|
then `export` and `deploy` report it as installed but never configured, and it runs
|
|
236
236
|
on its own defaults.
|
|
237
237
|
|
|
238
|
-
**`
|
|
238
|
+
**`npx @xano/sdk marketplace reinstall <package>`** re-asks the questions, offering this
|
|
239
239
|
project's current settings as the defaults, and switches a module back on if it was
|
|
240
|
-
turned off. **`
|
|
240
|
+
turned off. **`npx @xano/sdk marketplace remove <package>`** uninstalls it and drops its
|
|
241
241
|
settings and its contributed lines together. A plain `npm uninstall` leaves the
|
|
242
242
|
`"xanosdk"` block behind, and a package that block names but that is no longer
|
|
243
243
|
installed fails every `--frozen-lock` run until you run `reinstall` or `remove`.
|
|
@@ -259,14 +259,14 @@ Writing one is [The module contract](module-contract.md): the manifest fields, t
|
|
|
259
259
|
command line:
|
|
260
260
|
|
|
261
261
|
```bash
|
|
262
|
-
|
|
262
|
+
npx @xano/sdk init my-app --web
|
|
263
263
|
```
|
|
264
264
|
|
|
265
265
|
It is a launcher, not a second scaffolder: a configurator is downloaded on
|
|
266
266
|
demand, serves a local page, and finishes by running `init` with the flags your
|
|
267
267
|
choices imply — printing the equivalent command so the project stays
|
|
268
268
|
reproducible from a script. Everything after `--web` is passed to it untouched,
|
|
269
|
-
including `--help`, which is why that one form reaches the network. `
|
|
269
|
+
including `--help`, which is why that one form reaches the network. `npx @xano/sdk help
|
|
270
270
|
init` stays offline, like `init` itself.
|
|
271
271
|
|
|
272
272
|
Because the configurator is fetched at run time, `--web` needs the npm registry
|
|
@@ -279,7 +279,7 @@ into `xano/index.ts` by hand after `npm install`.
|
|
|
279
279
|
|
|
280
280
|
To point `npm run dev` at a real backend, copy `.env.example` to `.env.local` — both
|
|
281
281
|
live at the **project root**, next to `vite.config.ts` — and set `VITE_XANO_HOST` to a
|
|
282
|
-
deployed URL. Deployed builds don't need it: `
|
|
282
|
+
deployed URL. Deployed builds don't need it: `npx @xano/sdk deploy <entry> --static <dir>` injects the
|
|
283
283
|
backend URL as `window.XANO_HOST`, which takes precedence.
|
|
284
284
|
|
|
285
285
|
The frontend ships `Button` and `Card` already vendored, plus a pre-configured
|
|
@@ -301,9 +301,9 @@ and there is no `tailwind.config.js`. That one stylesheet backs both frameworks.
|
|
|
301
301
|
`init` renders it from a theme you choose, using shadcn's own two-part model:
|
|
302
302
|
|
|
303
303
|
```bash
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
304
|
+
npx @xano/sdk init my-app --theme zinc-blue # a base color, plus an accent over it
|
|
305
|
+
npx @xano/sdk init my-app --theme stone # a base color alone
|
|
306
|
+
npx @xano/sdk init my-app --theme zinc --radius 0
|
|
307
307
|
```
|
|
308
308
|
|
|
309
309
|
Base colors — the full token set: `neutral` (default), `stone`, `zinc`, `mauve`,
|
|
@@ -317,8 +317,8 @@ the chart ramp, and the sidebar primary: `amber`, `blue`, `cyan`, `emerald`,
|
|
|
317
317
|
generator's, or your team's:
|
|
318
318
|
|
|
319
319
|
```bash
|
|
320
|
-
|
|
321
|
-
|
|
320
|
+
npx @xano/sdk init my-app --theme https://ui.shadcn.com/r/themes/slate.json
|
|
321
|
+
npx @xano/sdk init my-app --theme ./brand-theme.json
|
|
322
322
|
```
|
|
323
323
|
|
|
324
324
|
`--radius <len>` overrides the corner radius (a bare number is rem). Everything
|
|
@@ -349,7 +349,7 @@ on every page load of your app, a failure behind a firewall, and a privacy
|
|
|
349
349
|
question someone inherits later.
|
|
350
350
|
|
|
351
351
|
```bash
|
|
352
|
-
|
|
352
|
+
npx @xano/sdk init my-app --font geist --font-heading instrument-serif --icons tabler
|
|
353
353
|
```
|
|
354
354
|
|
|
355
355
|
- `--font <id>` — body text (Tailwind's `--font-sans`, which v4 also uses as the
|