@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/llms.txt
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# xanosdk v1.0.
|
|
1
|
+
# xanosdk v1.0.15
|
|
2
2
|
|
|
3
3
|
> TypeScript SDK that compiles a typed Xano workspace into the importable packageExport JSON bundle.
|
|
4
4
|
|
|
@@ -6,8 +6,8 @@ Xano is one platform to build, run and govern AI-built software: one WORKSPACE
|
|
|
6
6
|
serves a managed PostgreSQL database, HTTP APIs, background tasks, realtime
|
|
7
7
|
websocket channels, AI agents, MCP servers, file storage and redis. This SDK
|
|
8
8
|
authors it in TypeScript — typed def objects registered on a
|
|
9
|
-
`workspace(name)` — compiled to one importable bundle by `
|
|
10
|
-
./xano/index.ts`, shipped live by `
|
|
9
|
+
`workspace(name)` — compiled to one importable bundle by `npx @xano/sdk export
|
|
10
|
+
./xano/index.ts`, shipped live by `deploy`.
|
|
11
11
|
|
|
12
12
|
Def modules execute at BUILD time only: `s.*` factories return data, and the engine
|
|
13
13
|
runs the compiled stack per request — statements in order, a statement's `as:`
|
|
@@ -41,7 +41,7 @@ plain file read resolves them at the version you have.
|
|
|
41
41
|
- [Object kinds](llms/object-kinds.md): Read when deciding WHAT to build — every authorable primitive, what each is, and which factory + register method builds it. Also when `register*` will not typecheck an array built by `.flatMap()`/`.concat()`.
|
|
42
42
|
- [Core def shapes](llms/kinds-core.md): Read when authoring a function, query, api group, task, workflow test, middleware, tool, or addon — and for the `response` and `expr` shapes every one of them uses.
|
|
43
43
|
- [Consuming defs from a client](llms/client.md): Read when a frontend calls the deployed backend or imports a def — request types and zod schemas without the import, its cost, `window.XANO_HOST`, local dev, file URLs, a Node spot-check.
|
|
44
|
-
- [Toolchain modules](llms/toolchain.md): Read when `package.json` has a `"xanosdk"` block or you run `
|
|
44
|
+
- [Toolchain modules](llms/toolchain.md): Read when `package.json` has a `"xanosdk"` block or you run `npx @xano/sdk marketplace`.
|
|
45
45
|
- [Error index](llms/errors.md): Read when a request, test, build, or pull fails with a message you did not write — the string, its cause, and where the fix is.
|
|
46
46
|
- [Saved unit tests, assertions, and mocks](llms/tests.md): Read when authoring a `workflowTest()` stack, when a query/function/middleware carries `tests`, when a statement needs a `mock`, or when running a deployed environment's tests.
|
|
47
47
|
- [Agent and MCP def shapes](llms/kinds-agent-mcp.md): Read when building an MCP server (tools, prompts, resources) or an `agent()`.
|
|
@@ -112,7 +112,7 @@ export default workspace("my-blog")
|
|
|
112
112
|
.registerQueries([createPost, listPosts]);
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
Compile: `
|
|
115
|
+
Compile: `npx @xano/sdk export ./index.ts --out bundle.json` (or `writeBundle(app, path)`
|
|
116
116
|
from `@xano/sdk/node` in code). The default export must be the `Xano` registry. The entry must be an
|
|
117
117
|
ES module (Xano SDK defs are ESM-only): set `"type": "module"` in the nearest
|
|
118
118
|
package.json or name the entry `.mts`. `npm init -y` writes `"type": "commonjs"`,
|
|
@@ -120,7 +120,7 @@ which fails with a "must be ES modules" error until you switch it to module.
|
|
|
120
120
|
|
|
121
121
|
Set `canonical` on every `apiGroup`. The engine mints the URL token server-side, so
|
|
122
122
|
without one a group's client paths are unresolvable until a lock exists: the bundle
|
|
123
|
-
exports fine and `
|
|
123
|
+
exports fine and `npx @xano/sdk routes` / `getPath()` then fail on the very queries it just
|
|
124
124
|
built. An explicit `canonical` resolves them from the source alone.
|
|
125
125
|
⚠ A canonical is unique across the whole INSTANCE, not per workspace — two
|
|
126
126
|
workspaces cannot serve the same one, and no flag shares it. One set in code is a PIN:
|
|
@@ -134,8 +134,8 @@ operand, a `ref()` nothing binds). Each has a legitimate use, so each only warns
|
|
|
134
134
|
but nothing fails on a message no one reads, so in CI and in unattended agent builds
|
|
135
135
|
pass `--strict` (`emitBundle(app, { strict: true })` / `app.export({ strict: true })`):
|
|
136
136
|
every warning becomes a hard failure. Same bundle bytes either way.
|
|
137
|
-
Before calling the work done: `npm run typecheck`, `
|
|
138
|
-
`
|
|
137
|
+
Before calling the work done: `npm run typecheck`, `npx @xano/sdk export <entry> --strict`,
|
|
138
|
+
`deploy <entry>`, then `test run-all` against what deployed.
|
|
139
139
|
|
|
140
140
|
Identity: object guids derive from `(type, name)` — a query's from `(api group,
|
|
141
141
|
verb, name)` — so renames change identity.
|
|
@@ -144,15 +144,15 @@ BESIDE THE ENTRY FILE — `xano/xano.lock` for the standard scaffold,
|
|
|
144
144
|
NOT the project root — which you COMMIT (`--no-lock` opts out; CI guard
|
|
145
145
|
`--frozen-lock` fails instead of changing it).
|
|
146
146
|
To rename an object: rename in code, export (stderr prints the exact fix-up), run
|
|
147
|
-
`
|
|
147
|
+
`npx @xano/sdk lock rename <kind> <old> <new>`, export again — the original guid is emitted
|
|
148
148
|
under the new name, so the engine renames in place instead of delete+create. Taking
|
|
149
|
-
over an existing workspace: `
|
|
149
|
+
over an existing workspace: `npx @xano/sdk lock import <live-bundle.json>` first, then
|
|
150
150
|
export. Pruning, programmatic seeding, and which commands write the lock:
|
|
151
151
|
`llms/lock.md`.
|
|
152
152
|
|
|
153
153
|
## Deploy
|
|
154
154
|
|
|
155
|
-
`
|
|
155
|
+
Commands here run as `npx @xano/sdk <cmd>`: `init` → `deploy` → URL. A deploy runs the same compile pipeline as
|
|
156
156
|
`export` (honoring `xano.lock`), imports the result, and prints the URL.
|
|
157
157
|
⚠ Every deploy is a FULL REPLACE of its destination — objects AND records.
|
|
158
158
|
|
|
@@ -168,7 +168,7 @@ and a `tenant:` only if throwaway (`standard`/`run` refused).
|
|
|
168
168
|
|
|
169
169
|
**Destinations** — the Xano Engine by default, real only when you say so:
|
|
170
170
|
|
|
171
|
-
- `
|
|
171
|
+
- `deploy [source]` → the Xano Engine on this machine (no account). `--ephemeral` → a NAMED, auto-expiring ephemeral (~1h; `--expires-hours`
|
|
172
172
|
1–24), tracked in `./.xano/ephemeral.json`, so deploying again REFRESHES it at the same
|
|
173
173
|
URL; if it expired or was swept, a fresh one is created and the new URL called out.
|
|
174
174
|
⚠ Only the BACKEND URL survives a refresh — the replace clears static hosting, so
|
|
@@ -176,17 +176,17 @@ and a `tenant:` only if throwaway (`standard`/`run` refused).
|
|
|
176
176
|
(not under `--keep-data`, which MERGES an env a deploy filled: rows kept, no re-seed,
|
|
177
177
|
removed objects deleted; ⚠ a rename loses values, a RETYPE reads unfit ones as null, env
|
|
178
178
|
VALUES are not applied, a table trigger refuses it — `--reset` replaces and re-seeds).
|
|
179
|
-
- `
|
|
179
|
+
- `release create <name>` cuts from a running source and LANDS in your workspace
|
|
180
180
|
— the record that it came up, and the only thing `promote`/`tenant deploy` take. A
|
|
181
181
|
taken name is refused, and so is one that addresses a LOCATION instead of naming: `/`,
|
|
182
182
|
`\`, `:`, or a leading `.`. Every export derives its FILENAME from the name it is given,
|
|
183
183
|
so `release|ephemeral|workspace export` refuse those same shapes unless `--path` names
|
|
184
184
|
the file. Carries EVERY table's SCHEMA either way; `--seed[=<guids>]` adds
|
|
185
|
-
ROWS — guids from `
|
|
186
|
-
- `
|
|
185
|
+
ROWS — guids from `tables <backend>`; a redeploy KEEPS them.
|
|
186
|
+
- `release transfer <name> --to-profile <profile>` copies a release to another
|
|
187
187
|
workspace/instance by CONTENT (tar sha256): identical → reused; same name, other
|
|
188
188
|
bytes → exit 2.
|
|
189
|
-
- `
|
|
189
|
+
- `promote <release>` / `tenant deploy <tenant> <release>` land it.
|
|
190
190
|
`promote` adds a branch; ⚠ its TABLE edits hit live
|
|
191
191
|
(`--allow-shared-schema-changes`). `tenant deploy` REPLACES: DROPS tables it lacks,
|
|
192
192
|
CONVERTS retypes (`--seed`: rows).
|
|
@@ -204,24 +204,24 @@ and a `tenant:` only if throwaway (`standard`/`run` refused).
|
|
|
204
204
|
- Backend SECRETS stay out of the repo: declare the NAME, value empty, in `workspaceConfig({ env })`
|
|
205
205
|
passed to `registerWorkspace()`; the VALUE lives in `xano/.env` — gitignored, kept across a
|
|
206
206
|
pull, read by every build. `--backend-env-file <path>` replaces that default (CI has
|
|
207
|
-
no `xano/.env`), `--env-var KEY=VALUE` beats both, and `
|
|
207
|
+
no `xano/.env`), `--env-var KEY=VALUE` beats both, and `env pull` fills the file from
|
|
208
208
|
a running backend — the only command that writes `xano/.env`.
|
|
209
209
|
⚠ A deploy REPLACES the env set: a declared name with NO value refuses the deploy rather
|
|
210
210
|
than clearing the live one — `--allow-empty-env=NAME` clears it on purpose.
|
|
211
|
-
ONE live value, no deploy: `
|
|
211
|
+
ONE live value, no deploy: `env set NAME` (value on stdin) / `env unset NAME`.
|
|
212
212
|
(`--static-env` is the other one — PUBLIC frontend config.)
|
|
213
213
|
- A DOCUMENTATION token is a secret too, in a SECOND ignored file: source declares only the
|
|
214
214
|
gate — `documentation: { require_token: true }` on `workspaceConfig` or an `apiGroup` — and
|
|
215
215
|
the value lives in `xano/.secrets.json`, keyed by the object it gates. A literal `token`
|
|
216
|
-
FAILS the export. `
|
|
217
|
-
`
|
|
216
|
+
FAILS the export. `pull` writes that file and every build reads it back;
|
|
217
|
+
`secrets fill` MINTS one per gate that has none — a gate you AUTHORED has no value
|
|
218
218
|
to pull. CI, which does not have the file, passes `--secrets-file <path>` or
|
|
219
219
|
`--doc-token "<scope>=<value>"`
|
|
220
220
|
(scope = `workspace`, or the group's NAME).
|
|
221
221
|
⚠ OMISSION IS OPPOSITE PER SCOPE: off `workspaceConfig` the target's gate is left alone;
|
|
222
222
|
off an `apiGroup` it is CLEARED (an absent key there is written as the engine default). An
|
|
223
223
|
unsupplied gate refuses a `deploy` and fails the export for a publishing group.
|
|
224
|
-
- `
|
|
224
|
+
- `deploy --to workspace|tenant:<name>` skips the release flow to merge a LOCAL
|
|
225
225
|
build in, keeping the checks that need one (`--dry-run`, `--prune`, loss warnings) and
|
|
226
226
|
leaving nothing to roll back to. Prefer the release path.
|
|
227
227
|
⚠ Branches scope LOGIC: tables and microservices are shared by EVERY branch, so a
|
|
@@ -230,28 +230,28 @@ and a `tenant:` only if throwaway (`standard`/`run` refused).
|
|
|
230
230
|
⚠ `--replace` CLEARS BY WORKSPACE, NOT BY BRANCH: every non-live branch goes, with the
|
|
231
231
|
saved versions that would restore one — unrecoverable. Refused without
|
|
232
232
|
`--allow-branch-deletion`; `--yes` does not imply it. The default merge leaves them alone.
|
|
233
|
-
- `
|
|
233
|
+
- `workspace reset-tables <entry> --table <guid>` puts NAMED tables back to their
|
|
234
234
|
compiled `table({ seed })` rows, touching no other table. Dry run unless `--write`.
|
|
235
235
|
⚠ ROWS BEFORE LOGIC: rows are workspace-shared like schema, so they reach production when
|
|
236
236
|
applied even while the logic reading them is staged — no ordering makes a half-data change
|
|
237
237
|
atomic. Reset rows FIRST, then `promote`: new rows under old logic break only a feature
|
|
238
238
|
being removed; new logic over old rows breaks the one you are shipping.
|
|
239
|
-
- `
|
|
239
|
+
- `pull` refreshes THIS project from a backend: rewrites decoded files,
|
|
240
240
|
keeps yours, lists and confirms (`--yes`).
|
|
241
|
-
- `
|
|
242
|
-
- `
|
|
241
|
+
- `generate <source>`: the decoded tree ONLY, no project.
|
|
242
|
+
- `status` names the env this project last deployed to, its URL and its expiry.
|
|
243
243
|
|
|
244
|
-
**Frontend wiring.** `--static <dir>` (or `
|
|
244
|
+
**Frontend wiring.** `--static <dir>` (or `publish <dir>`) injects the env's backend URL as
|
|
245
245
|
`window.XANO_HOST` into EVERY html document in the build, before the app bundle runs,
|
|
246
246
|
so the frontend needs no rebuild to target an env. How to read it, local dev, verifying
|
|
247
247
|
the inject, and displaying a stored file: `llms/client.md`.
|
|
248
248
|
⚠ A static host serves its files verbatim, so everything injected is PUBLIC — base
|
|
249
249
|
URLs and publishable keys only, never secrets. Secrets go in backend env, read
|
|
250
250
|
server-side via `env(name)`.
|
|
251
|
-
⚠ `
|
|
251
|
+
⚠ `preflight` uses the deploy credential unless `XANO_VALIDATE_INSTANCE` /
|
|
252
252
|
`XANO_VALIDATE_TOKEN` (+ optional `XANO_VALIDATE_WORKSPACE_ID`) are set.
|
|
253
253
|
|
|
254
|
-
**Full CLI surface:** `
|
|
254
|
+
**Full CLI surface:** `npx @xano/sdk <command> --help` — every command, flag, default and accepted
|
|
255
255
|
backend; `manifest.json` carries the same in its `cli` array.
|
|
256
256
|
**Style:** reach statements through the `s` namespace (`s.db.add`, `s.math.add`, …).
|
|
257
257
|
The flat aliases (`dbAdd`, `setVar`, …) are identical in output; prefer `s.*`.
|
|
@@ -430,11 +430,11 @@ Non-obvious authoring rules:
|
|
|
430
430
|
refuses the pair (`export()` warns even unlocked); it is for pinning identity
|
|
431
431
|
across a rename, not for sharing a name.
|
|
432
432
|
- **`export()` vs `emitBundle()` vs `writeBundle()`:** `export()` returns the object,
|
|
433
|
-
`emitBundle()` the JSON, `writeBundle(app, path)` writes `
|
|
433
|
+
`emitBundle()` the JSON, `writeBundle(app, path)` writes `export`'s file. All
|
|
434
434
|
three run the SAME build-time checks, INCLUDING seed validation of a literal `seed: [...]`
|
|
435
435
|
array (row shape, unknown column, coercion, enum membership, the all-or-nothing `id`
|
|
436
436
|
rule). A DEFERRED seed — a thunk (`() => import("./seed.json")`) or `seedFile()` — is
|
|
437
|
-
checked only by the `
|
|
437
|
+
checked only by the `export`/`deploy` CLI path. Only `deploy` ships seed rows.
|
|
438
438
|
- Entry points: the `node:fs` writers (`writeBundle`/`writeArtifact`) and lock-file I/O
|
|
439
439
|
import from `@xano/sdk/node`, NOT the browser-safe `@xano/sdk` entry (a frontend
|
|
440
440
|
imports from it; request types come from `routes.gen.ts`). `@xano/sdk/internal` is the
|
|
@@ -442,15 +442,18 @@ Non-obvious authoring rules:
|
|
|
442
442
|
— a statement walker (`2.if.0` paths), a structural hash, `mvp:*` catalog, `tableRefOf`.
|
|
443
443
|
- **Intra-workspace imports use `.js` specifiers** (`../tables/links.js`), not
|
|
444
444
|
extensionless — the defs compile under `moduleResolution: bundler`. Add the `.js`.
|
|
445
|
-
- **Agents authenticate with env vars — never `
|
|
445
|
+
- **Agents authenticate with env vars — never `npx @xano/sdk login`.** `login` blocks on a
|
|
446
446
|
browser consent no agent can complete. Set all three of `$XANO_INSTANCE_URL`,
|
|
447
447
|
`$XANO_WORKSPACE_ID`, `$XANO_META_TOKEN` and run `deploy`/`promote` directly: no disk, no
|
|
448
448
|
rotation, so it survives repeated runs.
|
|
449
|
+
- Not signed in: ask the human whether they have a Xano account; never guess. No: sign
|
|
450
|
+
them up via https://app.dev.xano.com/.well-known/auth.md; it returns this triple once they confirm by email. Yes: the
|
|
451
|
+
human runs `login`.
|
|
449
452
|
- The triple outranks every other credential (`--config`, `$XANO_PROFILE` and
|
|
450
453
|
`$XANO_REFRESH_TOKEN` included, each named on stderr when displaced). Setting SOME of the
|
|
451
454
|
three is a hard error, so a misspelled secret cannot fall through to whatever credential
|
|
452
455
|
the runner has. An explicit `--profile` against it is a hard error too, not a displacement.
|
|
453
|
-
- On disk: `
|
|
456
|
+
- On disk: `npx @xano/sdk profile add <name> --instance … --workspace-id <n>` reads the token
|
|
454
457
|
from piped stdin, else PROMPTS (a flag would reach the process list); the instance must accept it.
|
|
455
458
|
`auth.json` holds a map of named profiles, selected by `--profile <name>`. The older
|
|
456
459
|
`$XANO_REFRESH_TOKEN` + `$XANO_CLIENT_ID` pair still works but ROTATES: single-use.
|