@elisra-devops/docgen-data-provider 1.106.0 → 1.107.0

package/.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: "🚀 publish"
+name: '🚀 publish'
 
 on:
   push:
@@ -7,10 +7,14 @@ on:
     paths-ignore:
       - '.github/**'
   workflow_dispatch:
-      
+
 permissions:
   contents: write
 
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: false
+
 jobs:
   release:
     name: 🚀 publish
@@ -20,8 +24,10 @@ jobs:
       - name: 📚 checkout
         uses: actions/checkout@v4
         with:
-          token:  ${{ secrets.ELISRADEVOPS_ACCESS_TOKEN }}
-          
+          token: ${{ secrets.ELISRADEVOPS_ACCESS_TOKEN }}
+          ref: main
+          fetch-depth: 0
+
       - name: 🟢 node
         uses: actions/setup-node@v4
         with:
@@ -35,12 +41,26 @@ jobs:
 
       - run: npm run build
 
-      - name: 'Automated Version Bump'
-        uses: 'phips28/gh-action-bump-version@master'
-        with:
-          commit-message: 'CI: bumps version to {{version}} [skip ci]'
+      - name: Check if current version exists on npm
+        id: check_npm_version
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+          if npm view "${PACKAGE_NAME}@${PACKAGE_VERSION}" version >/dev/null 2>&1; then
+            echo "already_published=true" >> "$GITHUB_OUTPUT"
+            echo "${PACKAGE_NAME}@${PACKAGE_VERSION} already exists on npm. Skipping publish and version bump."
+          else
+            echo "already_published=false" >> "$GITHUB_OUTPUT"
+          fi
 
       - name: 🚀 publish
+        if: steps.check_npm_version.outputs.already_published != 'true'
         run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+
+      - name: 'Automated Version Bump'
+        if: steps.check_npm_version.outputs.already_published != 'true'
+        uses: 'phips28/gh-action-bump-version@master'
+        with:
+          commit-message: 'CI: bumps version to {{version}} [skip ci]'

package/README.md

@@ -63,3 +63,10 @@ The default export is `DgDataProviderAzureDevOps`, which creates module-specific
 - This library uses `axios` and retries some transient failures (timeouts/429/5xx).
 - `TicketsDataProvider.GetSharedQueries()` supports doc-type specific query layouts (e.g. `std`, `str`, `svd`, `srs`, `test-reporter`) and falls back to the provided root path when a dedicated folder is missing.
 - In Node.js, the HTTP client is configured with `rejectUnauthorized: false` in `src/helpers/tfs.ts`, which may be required for some internal setups but is a security tradeoff.
+
+## Release pipeline notes
+
+- GitHub Actions publish workflow runs on `main` pushes (and manual dispatch).
+- `npm publish` runs before version bump/tag.
+- If current `package.json` version already exists on npm, publish and bump are skipped.
+- On failed historical runs, prefer triggering a new run from latest `main` instead of rerunning an old workflow execution.

package/bin/modules/TicketsDataProvider.d.ts

@@ -1,5 +1,10 @@
 import { Links, Trace, Relations } from '../helpers/helper';
 import { Query } from '../models/tfs-data';
+type HistoricalQueryListItem = {
+    id: string;
+    queryName: string;
+    path: string;
+};
 export default class TicketsDataProvider {
     orgUrl: string;
     token: string;
@@ -37,6 +42,7 @@ export default class TicketsDataProvider {
      * @param docType document type
      * @returns
      */
+    private normalizeSharedQueriesPath;
     GetSharedQueries(project: string, path: string, docType?: string): Promise<any>;
     /**
      * Fetches the fields of a specific work item type.
@@ -162,6 +168,36 @@ export default class TicketsDataProvider {
     GetQueryResultsByWiqlHref(wiqlHref: string, project: string): Promise<any>;
     GetQueryResultsByWiqlString(wiql: string, projectName: string): Promise<any>;
     GetQueryResultById(query: string, project: string): Promise<any>;
+    private normalizeHistoricalAsOf;
+    private normalizeHistoricalCompareValue;
+    private normalizeTestPhaseValue;
+    private isTestCaseType;
+    private toHistoricalRevision;
+    private extractHistoricalWorkItemIds;
+    private appendAsOfToWiql;
+    private appendApiVersion;
+    private shouldRetryHistoricalWithLowerVersion;
+    private withHistoricalApiVersionFallback;
+    private chunkHistoricalWorkItemIds;
+    private normalizeHistoricalQueryPath;
+    private normalizeHistoricalQueryRoot;
+    private fetchHistoricalWorkItemsBatch;
+    private executeHistoricalQueryAtAsOf;
+    private toHistoricalWorkItemSnapshot;
+    private getHistoricalSnapshot;
+    private collectHistoricalQueries;
+    /**
+     * Returns a flat list of shared queries for historical/as-of execution.
+     */
+    GetHistoricalQueries(project: string, path?: string): Promise<HistoricalQueryListItem[]>;
+    /**
+     * Runs a shared query as-of a specific date-time and returns a flat work-item table snapshot.
+     */
+    GetHistoricalQueryResults(queryId: string, project: string, asOfInput: string): Promise<any>;
+    /**
+     * Compares a shared query between two date-time baselines using the feature's noise-control fields.
+     */
+    CompareHistoricalQueryResults(queryId: string, project: string, baselineAsOfInput: string, compareToAsOfInput: string): Promise<any>;
     PopulateWorkItemsByIds(workItemsArray?: any[], projectName?: string): Promise<any[]>;
     GetModeledQueryResults(results: any, project: string): Promise<Query>;
     BuildColumns(results: any, queryResult: Query): void;
@@ -301,3 +337,4 @@ export default class TicketsDataProvider {
      */
     GetCategorizedRequirementsByType(wiqlHref: string): Promise<any>;
 }
+export {};