@projectdochelp/s3te 3.4.3 → 3.4.5

package/README.md

@@ -293,6 +293,7 @@ GitHub preparation checklist:
 6. Add these repository variables:
    - `S3TE_ENVIRONMENT`
      Use the exact environment name from `s3te.config.json`, for example `dev`, `test`, or `prod`.
+     This is required for push-based sync when your project has more than one configured environment.
    - `S3TE_GIT_BRANCH` optional
      Use the branch that should trigger the sync job, for example `main`.
 7. In GitHub open `Settings -> Secrets and variables -> Actions -> Secrets`.
@@ -300,7 +301,9 @@ GitHub preparation checklist:
    - `AWS_ACCESS_KEY_ID`
    - `AWS_SECRET_ACCESS_KEY`
 9. Leave `.github/workflows/s3te-sync.yml` unchanged unless you want a custom CI flow. The scaffolded workflow already reads:
-   - the environment from `S3TE_ENVIRONMENT`
+   - the environment from the manual `workflow_dispatch` input when provided
+   - otherwise from `S3TE_ENVIRONMENT`
+   - otherwise automatically from `s3te.config.json` when exactly one environment exists
    - the branch from `S3TE_GIT_BRANCH` or defaults to `main`
    - the AWS region from `s3te.config.json`
 
@@ -327,6 +330,7 @@ Where to get the AWS values:
   [Manage access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-keys-admin-managed.html).
 - `S3TE_ENVIRONMENT`
   This is the environment key from your `s3te.config.json`, for example `test` or `prod`.
+  For repositories with multiple environments, set this variable or pass the environment manually when starting `workflow_dispatch`.
 - AWS region
   You do not need to copy this into GitHub. The workflow reads `environments.<name>.awsRegion` directly from `s3te.config.json`.
 
@@ -376,10 +380,13 @@ The scaffolded workflow looks like this:
 # Required GitHub repository secrets:
 # - AWS_ACCESS_KEY_ID
 # - AWS_SECRET_ACCESS_KEY
-# Required GitHub repository variable:
+# Required GitHub repository variable for push-based sync in multi-environment projects:
 # - S3TE_ENVIRONMENT (for example dev, test, or prod)
 # Optional GitHub repository variable:
 # - S3TE_GIT_BRANCH (defaults to main)
+# Notes:
+# - workflow_dispatch can override the environment manually
+# - if s3te.config.json contains exactly one environment, no S3TE_ENVIRONMENT variable is needed
 # This workflow reads s3te.config.json at runtime and syncs all variants into their own code buckets.
 name: S3TE Sync
 on:
@@ -423,7 +430,7 @@ jobs:
           WORKFLOW_INPUT_ENVIRONMENT: ${{ inputs.environment }}
           REPOSITORY_S3TE_ENVIRONMENT: ${{ vars.S3TE_ENVIRONMENT }}
         run: |
-          node -e "const fs=require('node:fs'); const requested=(process.env.WORKFLOW_INPUT_ENVIRONMENT || process.env.REPOSITORY_S3TE_ENVIRONMENT || '').trim(); const config=JSON.parse(fs.readFileSync('s3te.config.json','utf8')); const known=Object.keys(config.environments ?? {}); if(!requested){ console.error('Missing GitHub repository variable S3TE_ENVIRONMENT.'); process.exit(1);} const environmentConfig=config.environments?.[requested]; if(!environmentConfig){ console.error('Unknown environment ' + requested + '. Known environments: ' + (known.length > 0 ? known.join(', ') : '(none)') + '.'); process.exit(1);} fs.appendFileSync(process.env.GITHUB_OUTPUT, 'environment=' + requested + '\n'); fs.appendFileSync(process.env.GITHUB_OUTPUT, 'aws_region=' + environmentConfig.awsRegion + '\n');"
+          node -e "const fs=require('node:fs'); const fromInput=(process.env.WORKFLOW_INPUT_ENVIRONMENT || '').trim(); const fromVariable=(process.env.REPOSITORY_S3TE_ENVIRONMENT || '').trim(); const config=JSON.parse(fs.readFileSync('s3te.config.json','utf8')); const known=Object.keys(config.environments ?? {}); const requested=(fromInput || fromVariable || (known.length === 1 ? known[0] : '')).trim(); if(!requested){ console.error('Missing S3TE environment. Provide workflow_dispatch input \"environment\" or set GitHub repository variable S3TE_ENVIRONMENT. Known environments: ' + (known.length > 0 ? known.join(', ') : '(none)') + '.'); process.exit(1);} const environmentConfig=config.environments?.[requested]; if(!environmentConfig){ console.error('Unknown environment ' + requested + '. Known environments: ' + (known.length > 0 ? known.join(', ') : '(none)') + '.'); process.exit(1);} fs.appendFileSync(process.env.GITHUB_OUTPUT, 'environment=' + requested + '\n'); fs.appendFileSync(process.env.GITHUB_OUTPUT, 'aws_region=' + environmentConfig.awsRegion + '\n');"
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v4
         with:
@@ -724,7 +731,8 @@ Filter notes:
 - multiple clauses are combined with logical `AND`
 - `__typename` matches the content model, for example `article`
 - supported legacy value wrappers are `S`, `N`, `BOOL`, `NULL`, and `L`
-- results are sorted deterministically; numeric `order` comes first, then `contentId`, then `id`
+- results are sorted deterministically; items with a numeric field `order` are rendered first in ascending order, then items without a numeric `order`, then `contentId`, then `id`
+- this also works with mirrored Webiny content if the model contains a field with the exact field ID `order` and type `number`
 
 **Example**
 
@@ -1018,6 +1026,13 @@ That makes the option example above equivalent to a config that contains:
 
 Use this for every Webiny model whose entries should be available to S3TE template commands like `dbitem`, `dbmulti`, `dbmultifile`, `dbmultifileitem`, or `dbpart`.
 
+If a Webiny model should control the output order for `dbmulti` or `dbmultifile`, add a field with:
+
+- field ID `order`
+- field type `number`
+
+S3TE sorts matching items by that numeric `order` in ascending order. Items without a numeric `order` stay at the end.
+
 If different environments should read from different Webiny installations or tenants, run the option command per environment:
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@projectdochelp/s3te",
-  "version": "3.4.3",
+  "version": "3.4.5",
   "description": "CLI, render core, AWS adapter, and testkit for S3TemplateEngine projects",
   "repository": {
     "type": "git",

package/packages/aws-adapter/src/runtime/common.mjs

@@ -36,6 +36,12 @@ function normalizeKey(value) {
   return String(value).replace(/\\/g, "/");
 }
 
+function matchesProjectRelativeRoot(key, root) {
+  const normalizedKey = normalizeKey(key);
+  const normalizedRoot = normalizeKey(root);
+  return normalizedKey === normalizedRoot || normalizedKey.startsWith(`${normalizedRoot}/`);
+}
+
 function buildSourceId(environment, variant, language, outputKey) {
   return `${environment}#${variant}#${language}#${outputKey}`;
 }
@@ -312,17 +318,18 @@ export class S3TemplateRepository {
     const normalized = normalizeKey(key);
     const activeVariant = this.environmentManifest.variants[this.activeVariantName];
 
-    if (normalized.startsWith(`${this.activeVariantName}/`)) {
+    if (matchesProjectRelativeRoot(normalized, activeVariant.partDir)) {
+      const normalizedPartDir = normalizeKey(activeVariant.partDir);
       return {
         bucket: activeVariant.codeBucket,
-        objectKey: normalized
+        objectKey: `part/${normalized.slice(normalizedPartDir.length + 1)}`
       };
     }
 
-    if (normalized.startsWith(`${activeVariant.partDir}/`)) {
+    if (normalized.startsWith(`${this.activeVariantName}/`)) {
       return {
         bucket: activeVariant.codeBucket,
-        objectKey: `part/${normalized.slice(activeVariant.partDir.length + 1)}`
+        objectKey: normalized
       };
     }
 

package/packages/cli/src/project.mjs

@@ -365,10 +365,13 @@ function githubSyncWorkflowTemplate() {
   return `# Required GitHub repository secrets:
 # - AWS_ACCESS_KEY_ID
 # - AWS_SECRET_ACCESS_KEY
-# Required GitHub repository variable:
+# Required GitHub repository variable for push-based sync in multi-environment projects:
 # - S3TE_ENVIRONMENT (for example dev, test, or prod)
 # Optional GitHub repository variable:
 # - S3TE_GIT_BRANCH (defaults to main)
+# Notes:
+# - workflow_dispatch can override the environment manually
+# - if s3te.config.json contains exactly one environment, no S3TE_ENVIRONMENT variable is needed
 # This workflow reads s3te.config.json at runtime and syncs all variants into their own code buckets.
 name: S3TE Sync
 
@@ -413,7 +416,7 @@ jobs:
           WORKFLOW_INPUT_ENVIRONMENT: \${{ inputs.environment }}
           REPOSITORY_S3TE_ENVIRONMENT: \${{ vars.S3TE_ENVIRONMENT }}
         run: |
-          node -e "const fs=require('node:fs'); const requested=(process.env.WORKFLOW_INPUT_ENVIRONMENT || process.env.REPOSITORY_S3TE_ENVIRONMENT || '').trim(); const config=JSON.parse(fs.readFileSync('s3te.config.json','utf8')); const known=Object.keys(config.environments ?? {}); if(!requested){ console.error('Missing GitHub repository variable S3TE_ENVIRONMENT.'); process.exit(1);} const environmentConfig=config.environments?.[requested]; if(!environmentConfig){ console.error('Unknown environment ' + requested + '. Known environments: ' + (known.length > 0 ? known.join(', ') : '(none)') + '.'); process.exit(1);} fs.appendFileSync(process.env.GITHUB_OUTPUT, 'environment=' + requested + '\\n'); fs.appendFileSync(process.env.GITHUB_OUTPUT, 'aws_region=' + environmentConfig.awsRegion + '\\n');"
+          node -e "const fs=require('node:fs'); const fromInput=(process.env.WORKFLOW_INPUT_ENVIRONMENT || '').trim(); const fromVariable=(process.env.REPOSITORY_S3TE_ENVIRONMENT || '').trim(); const config=JSON.parse(fs.readFileSync('s3te.config.json','utf8')); const known=Object.keys(config.environments ?? {}); const requested=(fromInput || fromVariable || (known.length === 1 ? known[0] : '')).trim(); if(!requested){ console.error('Missing S3TE environment. Provide workflow_dispatch input \"environment\" or set GitHub repository variable S3TE_ENVIRONMENT. Known environments: ' + (known.length > 0 ? known.join(', ') : '(none)') + '.'); process.exit(1);} const environmentConfig=config.environments?.[requested]; if(!environmentConfig){ console.error('Unknown environment ' + requested + '. Known environments: ' + (known.length > 0 ? known.join(', ') : '(none)') + '.'); process.exit(1);} fs.appendFileSync(process.env.GITHUB_OUTPUT, 'environment=' + requested + '\\n'); fs.appendFileSync(process.env.GITHUB_OUTPUT, 'aws_region=' + environmentConfig.awsRegion + '\\n');"
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v4
         with:

package/packages/core/src/content-query.mjs

@@ -83,13 +83,42 @@ function compareFilter(actual, expected, filterType) {
   return actual === expected;
 }
 
+function coerceNumericOrderValue(value) {
+  if (typeof value === "number") {
+    return Number.isFinite(value) ? value : null;
+  }
+
+  if (typeof value === "string") {
+    const trimmed = value.trim();
+    if (!trimmed) {
+      return null;
+    }
+    const parsed = Number(trimmed);
+    return Number.isFinite(parsed) ? parsed : null;
+  }
+
+  const legacyValue = legacyAttributeValueToPlain(value);
+  if (legacyValue !== undefined && legacyValue !== value) {
+    return coerceNumericOrderValue(legacyValue);
+  }
+
+  return null;
+}
+
+function readOrderValue(item) {
+  const candidate = item?.values?.order ?? item?.order;
+  return coerceNumericOrderValue(candidate);
+}
+
 function compareOrder(a, b) {
-  const aHasOrder = typeof a.values?.order === "number";
-  const bHasOrder = typeof b.values?.order === "number";
+  const aOrder = readOrderValue(a);
+  const bOrder = readOrderValue(b);
+  const aHasOrder = aOrder !== null;
+  const bHasOrder = bOrder !== null;
 
   if (aHasOrder && bHasOrder) {
-    if (a.values.order !== b.values.order) {
-      return a.values.order - b.values.order;
+    if (aOrder !== bOrder) {
+      return aOrder - bOrder;
     }
   } else if (aHasOrder && !bHasOrder) {
     return -1;