Skip to content
This repository has been archived by the owner on Oct 1, 2024. It is now read-only.

Commit

Permalink
Deprecate @shopify/react-app-bridge-universal-provider
Browse files Browse the repository at this point in the history
  • Loading branch information
jesstelford committed Aug 27, 2024
1 parent 3fe224f commit 6d7a626
Show file tree
Hide file tree
Showing 12 changed files with 10 additions and 253 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ These libraries compose together to help you create performant modern JS apps th

## Usage

The Quilt repo is managed as a monorepo that is composed of 71 npm packages and one Ruby gem.
The Quilt repo is managed as a monorepo that is composed of 70 npm packages and one Ruby gem.
Each package/gem has its own `README.md` and documentation describing usage.

### Package Index
Expand Down Expand Up @@ -55,7 +55,6 @@ Each package/gem has its own `README.md` and documentation describing usage.
| [@shopify/phone](packages/phone) | <a href="https://badge.fury.io/js/%40shopify%2Fphone"><img src="https://badge.fury.io/js/%40shopify%2Fphone.svg" width="200px" /></a> | Phone number utilities for formatting phone numbers |
| [@shopify/polyfills](packages/polyfills) | <a href="https://badge.fury.io/js/%40shopify%2Fpolyfills"><img src="https://badge.fury.io/js/%40shopify%2Fpolyfills.svg" width="200px" /></a> | Blessed polyfills for web platform features |
| [@shopify/predicates](packages/predicates) | <a href="https://badge.fury.io/js/%40shopify%2Fpredicates"><img src="https://badge.fury.io/js/%40shopify%2Fpredicates.svg" width="200px" /></a> | A set of common JavaScript predicates |
| [@shopify/react-app-bridge-universal-provider](packages/react-app-bridge-universal-provider) | <a href="https://badge.fury.io/js/%40shopify%2Freact-app-bridge-universal-provider"><img src="https://badge.fury.io/js/%40shopify%2Freact-app-bridge-universal-provider.svg" width="200px" /></a> | A self-serializing/deserializing `app-bridge-react` provider that works for isomorphic applications |
| [@shopify/react-async](packages/react-async) | <a href="https://badge.fury.io/js/%40shopify%2Freact-async"><img src="https://badge.fury.io/js/%40shopify%2Freact-async.svg" width="200px" /></a> | Tools for creating powerful, asynchronously-loaded React components |
| [@shopify/react-bugsnag](packages/react-bugsnag) | <a href="https://badge.fury.io/js/%40shopify%2Freact-bugsnag"><img src="https://badge.fury.io/js/%40shopify%2Freact-bugsnag.svg" width="200px" /></a> | An opinionated wrapper for Bugsnag's React plugin |
| [@shopify/react-compose](packages/react-compose) | <a href="https://badge.fury.io/js/%40shopify%2Freact-compose"><img src="https://badge.fury.io/js/%40shopify%2Freact-compose.svg" width="200px" /></a> | Cleanly compose multiple component enhancers together with minimal fuss |
Expand Down
6 changes: 6 additions & 0 deletions packages/react-app-bridge-universal-provider/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

⚠️ DEPRECATED

This package has been deprecated and should no longer be used.

For legacy documentation, see [v3.1.4](https://github.com/Shopify/quilt/blob/%40shopify/react-app-bridge-universal-provider%403.1.4/packages/react-app-bridge-universal-provider/README.md).

## 3.1.4

### Patch Changes
Expand Down
34 changes: 3 additions & 31 deletions packages/react-app-bridge-universal-provider/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,7 @@
# `@shopify/react-app-bridge-universal-provider`

[![Build Status](https://github.com/Shopify/quilt/workflows/Node-CI/badge.svg?branch=main)](https://github.com/Shopify/quilt/actions?query=workflow%3ANode-CI)
[![Build Status](https://github.com/Shopify/quilt/workflows/Ruby-CI/badge.svg?branch=main)](https://github.com/Shopify/quilt/actions?query=workflow%3ARuby-CI)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md) [![npm version](https://badge.fury.io/js/%40shopify%2Freact-app-bridge-universal-provider.svg)](https://badge.fury.io/js/%40shopify%2Freact-app-bridge-universal-provider.svg) [![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@shopify/react-app-bridge-universal-provider.svg)](https://img.shields.io/bundlephobia/minzip/@shopify/react-app-bridge-universal-provider.svg)
⚠️ DEPRECATED

A self-serializing/deserializing [`app-bridge-react`](https://github.com/Shopify/app-bridge/tree/master/packages/app-bridge-react) provider that works for isomorphic applications.
This package has been deprecated and should no longer be used.

## Installation

```bash
yarn add @shopify/react-app-bridge-universal-provider
```

## Usage

### Props

The component takes children, `apiKey`, `shopOrigin`, and `forceRedirect`. Similar to `@shopify/app-bridge-react`'s Provider.

### Example

```tsx
// App.tsx

import {AppBridgeUniversalProvider} from '@shopify/react-app-bridge-universal-provider';

function App({apiKey, shopOrigin}: {apiKey?: string; shopOrigin?: string}) {
return (
<AppBridgeUniversalProvider apiKey={apiKey} shopOrigin={shopOrigin}>
{/* rest of the app */}
</AppBridgeUniversalProvider>
);
}
```
For legacy documentation, see [v3.1.4](https://github.com/Shopify/quilt/blob/%40shopify/react-app-bridge-universal-provider%403.1.4/packages/react-app-bridge-universal-provider/README.md).
54 changes: 0 additions & 54 deletions packages/react-app-bridge-universal-provider/package.json

This file was deleted.

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion packages/react-app-bridge-universal-provider/src/index.ts

This file was deleted.

This file was deleted.

13 changes: 0 additions & 13 deletions packages/react-app-bridge-universal-provider/tsconfig.json

This file was deleted.

1 change: 0 additions & 1 deletion packages/react-universal-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ It is particularly useful for simple object or primitive that need to be sync up

The list below show a few packages with more complex universal provider:

[@shopify/react-app-bridge-universal-provider](../react-app-bridge-universal-provider)
[@shopify/react-csrf-universal-provider](../react-csrf-universal-provider)
[@shopify/react-graphql-universal-provider`](../react-graphql-universal-provider)
[@shopify/react-i18n-universal-provider](../react-i18n-universal-provider)
Expand Down
1 change: 0 additions & 1 deletion tests/no-new-packages.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ describe('no new packages', () => {
'phone',
'polyfills',
'predicates',
'react-app-bridge-universal-provider',
'react-async',
'react-bugsnag',
'react-compose',
Expand Down
1 change: 0 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
{"path": "./packages/phone"},
{"path": "./packages/polyfills"},
{"path": "./packages/predicates"},
{"path": "./packages/react-app-bridge-universal-provider"},
{"path": "./packages/react-async"},
{"path": "./packages/react-bugsnag"},
{"path": "./packages/react-compose"},
Expand Down

0 comments on commit 6d7a626

Please sign in to comment.