@microsoft/rayfin-guide 1.35.0 → 1.35.1

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.
@@ -78,6 +78,8 @@ services:
78
78
  data:
79
79
  enabled: true
80
80
  dialect: mssql
81
+ storage:
82
+ enabled: false
81
83
  staticHosting:
82
84
  enabled: true
83
85
  root: .
@@ -158,6 +160,12 @@ Configure an email provider for magic links, password resets, and email verifica
158
160
  | `useStartTls` | `boolean` | `false` | Use STARTTLS for the SMTP connection. |
159
161
  | `webPort` | `number` | `1080` | MailDev web UI port (local development only). |
160
162
 
163
+ #### `services.storage`
164
+
165
+ | Field | Type | Default | Description |
166
+ | --- | --- | --- | --- |
167
+ | `enabled` | `boolean` | `false` | Enable the storage service. |
168
+
161
169
  #### `services.staticHosting`
162
170
 
163
171
  | Field | Type | Default | Description |
@@ -38,6 +38,24 @@ services:
38
38
  | `buildCommand` | No | — | Shell command to run before packaging (for example, `npm run build`). |
39
39
  | `indexDocument` | No | — | Default document to serve for directory requests (for example, `index.html`). |
40
40
 
41
+ ### Declared package versions
42
+
43
+ Every `rayfin up` records which packages produced the deployment, under `packageVersions` in the runtime settings it uploads:
44
+
45
+ | Key | When it is sent |
46
+ | --- | --- |
47
+ | `@microsoft/rayfin-cli` | Always, set to the running CLI's version. |
48
+ | `@microsoft/rayfin-auth` | When your frontend package has the auth SDK installed, set to the installed version. |
49
+
50
+ You do not author this.
51
+ Run `rayfin up --dry-run` to see exactly which versions a deploy would declare, without deploying.
52
+
53
+ Once your tenant enforces static-hosting access control, a CLI too old to record its version cannot deploy a static-hosted app, and the deployment is rejected with instructions to upgrade:
54
+
55
+ ```bash
56
+ npm install -g @microsoft/rayfin-cli@latest
57
+ ```
58
+
41
59
  ### Example with a separate frontend directory
42
60
 
43
61
  If your frontend lives in a subdirectory:
@@ -133,7 +151,7 @@ The deploy tool updates the configuration and pushes it to the backend during de
133
151
 
134
152
  - The compressed ZIP archive must not exceed **100 MB**.
135
153
  - The CLI uses maximum compression to minimize upload size.
136
- - If your build output exceeds the limit, consider excluding large assets from the deployed bundle.
154
+ - If your build output exceeds the limit, consider excluding large assets or using the storage service for binary files.
137
155
 
138
156
  ## Complete example
139
157
 
@@ -182,6 +200,7 @@ If the ZIP exceeds 100 MB:
182
200
 
183
201
  - Review your build output for unnecessary files (source maps, unoptimized images).
184
202
  - Configure your bundler to exclude development artifacts from the production build.
203
+ - Move large binary assets to Rayfin storage instead of bundling them as static content.
185
204
 
186
205
  ### No remote endpoint configured
187
206
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/rayfin-guide",
3
- "version": "1.35.0",
3
+ "version": "1.35.1",
4
4
  "description": "Cross-cutting Builder guides for the Rayfin platform — discovered by `@microsoft/rayfin-docs` via the `rayfinDocs` package.json field convention.",
5
5
  "type": "module",
6
6
  "files": [